Skip to content

Commit 2ac6334

Browse files
readme updates
1 parent c5dae5f commit 2ac6334

File tree

4 files changed

+33
-8
lines changed

4 files changed

+33
-8
lines changed

README.md

Lines changed: 33 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,12 @@ ScribePal is an Open Source intelligent browser extension that leverages AI to e
1616
- [Windows](#windows)
1717
- [Development](#development)
1818
- [Installation](#installation)
19+
- [Alternative Installation Options](#alternative-installation-options)
20+
- [Install via Browser Stores](#install-via-browser-stores)
21+
- [Download from Releases](#download-from-releases)
1922
- [Building](#building)
20-
- [I. For development:](#i-for-development)
21-
- [II. For production:](#ii-for-production)
23+
- [I. For development](#i-for-development)
24+
- [II. For production](#ii-for-production)
2225
- [Linting](#linting)
2326
- [Installing](#installing)
2427
- [Usage](#usage)
@@ -41,7 +44,7 @@ It is compatible with all Chromium and Gecko-based browsers: Chrome, Vivaldi, Op
4144
- **Theming:** Supports light and dark themes.
4245
- **Chat Interface:** A draggable chat box for sending and receiving messages.
4346
- **Model Management:** Select, refresh, download, and delete models.
44-
- **Capture Tool:** Highlight HTML elements to capture text for the chat input.
47+
- **Advanced Capture Tools:** Options for capturing both text and images are available. Captured content is inserted directly into your chat using special tags (`@captured-text` for text and `@captured-image` for images).
4548
- **Prompt Customization:** Adjust and customize prompts to instruct the AI model on how to generate responses.
4649

4750
## Prerequisites
@@ -110,9 +113,31 @@ Also, ensure that the [Ollama](https://ollama.com) host is installed on your loc
110113
npm install
111114
```
112115

116+
### Alternative Installation Options
117+
118+
If you're not a developer, you can choose one of the following methods:
119+
120+
### 1. Install via Browser Stores
121+
122+
[![Chrome Store](./badges/chrome-add-on-badge.png)](https://chromewebstore.google.com/detail/godcjpkfkipmljclkgmohpookphckdfl?utm_source=github-repo)
123+
[![Edge Store](./badges/edge-add-on-badge.png)](https://microsoftedge.microsoft.com/addons/detail/scribepal/omffcjaihckmfdphencecfigafaoocmb)
124+
[![Firefox Add-on](./badges/firefox-add-on-badge.png)](https://addons.mozilla.org/en-US/firefox/addon/scribe-pal/)
125+
126+
> [!NOTE]
127+
> Releases available in the browser stores might be slightly out of sync with the GitHub releases. This can be due to the review process, packaging delays, or manual submission requirements. For the most up-to-date version, please refer to the [Releases](https://github.com/code-forge-temple/scribe-pal/releases) page.
128+
129+
### 2. Download from Releases
130+
131+
Visit the [Releases](https://github.com/code-forge-temple/scribe-pal/releases) page to download the latest packages:
132+
133+
- For Chromium-based browsers, download `chrome.zip`.
134+
- For Gecko-based browsers, download `firefox.zip`.
135+
136+
After downloading, unzip the package and [install](#installing) the extension manually.
137+
113138
### Building
114139
115-
#### I. For development:
140+
#### I. For development
116141
117142
To build the project for development, run:
118143
@@ -126,7 +151,7 @@ B. For Gecko-based browsers like Firefox, Waterfox, Pale Moon, and others:
126151
npm run dev:firefox
127152
```
128153
129-
#### II. For production:
154+
#### II. For production
130155
131156
To build the project for production, run:
132157
@@ -177,10 +202,10 @@ To install the the compiled extension, for:
177202
Use the toggle switch to activate the dark theme as desired.
178203
179204
3. **Launch the Chat Interface:**
180-
- Click “Show ScribePal chat” within the popup, or within the current page press Ctrl+Shift+Y.
181-
- A draggable chat box will open on the active webpage.
205+
- Click “Show ScribePal chat” in the popup or press Ctrl+Shift+Y.
206+
- A responsive, draggable chat box will open on the active webpage.
182207
- Use the chat interface to send messages to the Ollama AI service, review conversation history, and manage models.
183-
- Additional features include capturing selected HTML content (that can be referenced in the discussion with `@captured` tag) and customizing prompts (to instruct the loaded model on how to answer).
208+
- Additional features include capturing selected HTML content (that can be referenced in the discussion with `@captured-text` tag), capturing an image of an area on the page (that can be referenced in the discussion with `@captured-image` tag) and customizing prompts (to instruct the loaded model on how to answer).
184209
185210
4. **Interacting with the Chat:**
186211
- Type your query in the chat input and press Enter or click the `Send` button.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)