Skip to content

Commit d649df1

Browse files
readme and workflow updates
1 parent 2ac6334 commit d649df1

File tree

2 files changed

+29
-22
lines changed

2 files changed

+29
-22
lines changed

.github/workflows/main.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,17 @@ name: Build and Release
33
on:
44
push:
55
branches: [main]
6+
paths:
7+
- "src/**"
8+
- "webpack.config.mjs"
9+
- "package.json"
10+
- ".github/workflows/**"
611
pull_request:
12+
paths:
13+
- "src/**"
14+
- "webpack.config.mjs"
15+
- "package.json"
16+
- ".github/workflows/**"
717

818
permissions:
919
contents: write

README.md

Lines changed: 19 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,23 @@ ScribePal is an Open Source intelligent browser extension that leverages AI to e
66

77
<!-- TOC -->
88

9-
- [ScribePal](#scribepal)
10-
- [Table of Contents](#table-of-contents)
11-
- [Privacy](#privacy)
12-
- [Compatibility](#compatibility)
13-
- [Features](#features)
14-
- [Prerequisites](#prerequisites)
15-
- [Linux](#linux)
16-
- [Windows](#windows)
17-
- [Development](#development)
18-
- [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)
22-
- [Building](#building)
23-
- [I. For development](#i-for-development)
24-
- [II. For production](#ii-for-production)
25-
- [Linting](#linting)
26-
- [Installing](#installing)
27-
- [Usage](#usage)
28-
- [License](#license)
9+
- [Table of Contents](#table-of-contents)
10+
- [Privacy](#privacy)
11+
- [Compatibility](#compatibility)
12+
- [Features](#features)
13+
- [Prerequisites](#prerequisites)
14+
- [Linux](#linux)
15+
- [Windows](#windows)
16+
- [Development](#development)
17+
- [Installation](#installation)
18+
- [Alternative Installation Options](#alternative-installation-options)
19+
- [1. Install via Browser Stores](#1-install-via-browser-stores)
20+
- [2. Download from Releases](#2-download-from-releases)
21+
- [Building](#building)
22+
- [Linting](#linting)
23+
- [Installing in browser](#installing-in-browser)
24+
- [Usage](#usage)
25+
- [License](#license)
2926

3027
<!-- /TOC -->
3128

@@ -172,7 +169,7 @@ To lint the project, run:
172169
npm run lint
173170
```
174171
175-
### Installing
172+
### Installing in browser
176173
177174
To install the the compiled extension, for:
178175
- Chromium based browsers you need to go to
@@ -205,7 +202,7 @@ To install the the compiled extension, for:
205202
- Click “Show ScribePal chat” in the popup or press Ctrl+Shift+Y.
206203
- A responsive, draggable chat box will open on the active webpage.
207204
- Use the chat interface to send messages to the Ollama AI service, review conversation history, and manage models.
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).
205+
- 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) for VISION LLMs, and customizing prompts (to instruct the loaded model on how to answer).
209206
210207
4. **Interacting with the Chat:**
211208
- Type your query in the chat input and press Enter or click the `Send` button.

0 commit comments

Comments
 (0)