Skip to content

Commit

Permalink
README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
LVivona committed Jul 27, 2024
1 parent 69c7d1f commit 63ff650
Showing 1 changed file with 36 additions and 7 deletions.
43 changes: 36 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ Parseltongue is a powerful browser extension for text conversion and real-time t

| Feature | Firefox | Chrome |
|-----------------------------|------------------|------------------|
| Text Conversion | Fully compatible | Some bugs |
| Tokenization Visualization | Fully compatible | Some bugs |
| Popup UI | Fully compatible | Some bugs |
| Context Menu Integration | Fully compatible | Some bugs |
| Real-time Visualization | Fully compatible | Some bugs |
| Text Conversion | | |
| Tokenization Visualization | | |
| Popup UI | | |
| Context Menu Integration | | |
| Real-time Visualization | | |


## Features
Expand All @@ -32,6 +32,8 @@ cd parseltongue

### Build the Extension

**NOTE**: You can use the `/dist` folder within the repo as well, the bottom instruction are just for good measure.

Parseltongue uses Webpack to bundle the extension. Follow these steps to compile the extension:

1. **Install Dependencies**:
Expand All @@ -44,20 +46,47 @@ Parseltongue uses Webpack to bundle the extension. Follow these steps to compile
npm run build
```



### Load the Extension

#### Chrome

1. Go to `chrome://extensions/`
2. Enable "Developer mode"
3. Click "Load unpacked"
4. Select the `dist` directory
3. Select the `manifest.json` file in the `dist` directory

This comment has been minimized.

Copy link
@LVivona

LVivona Jul 28, 2024

Author Contributor

do you mind leaving the error you get within the browser because the browser-polyfill.js should be within the dist


#### Firefox

1. Go to `about:debugging#/runtime/this-firefox`
2. Click "Load Temporary Add-on..."
3. Select any file in the `dist` directory
3. Select the `manifest.json` file in the `dist` directory

### Accessing the Sidebar
After activating the extension through the popup, you'll need to open the sidebar to access ParselTongue's full functionality. The process differs slightly between Chrome and Firefox:
#### For Chrome Users

Locate the ParselTongue icon in your browser's toolbar.
Right-click on the icon to reveal a dropdown menu.
Select "Open side panel" from the options presented.
#### For Firefox Users
Look for the sidebar icon in your browser's toolbar (usually represented by a box with lines).
Click on this icon to toggle the sidebar view.
If you don't see the sidebar icon, you can:
Use the keyboard shortcut Ctrl+B (Cmd+B on Mac) to open the sidebar.
Or, go to View > Sidebar in the main menu and select ParselTongue.
For more detailed instructions on using Firefox's sidebar feature, you can refer to Mozilla's official support page: Using the Firefox Sidebar
Once opened, the ParselTongue sidebar will provide you with quick access to all of its text manipulation and analysis tools.
Happy prompting :)
## Usage
Expand Down

0 comments on commit 63ff650

Please sign in to comment.