Skip to content

Commit 508216a

Browse files
committed
docs: update installation instructions for release package
1 parent cf7618b commit 508216a

File tree

1 file changed

+20
-13
lines changed

1 file changed

+20
-13
lines changed

README.md

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -20,19 +20,12 @@ A Chrome extension that allows you to ask questions about web page content, imag
2020

2121
## Installation
2222

23-
1. Clone this repository
24-
2. Install dependencies:
25-
```bash
26-
npm install
27-
```
28-
3. Build the extension:
29-
```bash
30-
npm run build
31-
```
32-
4. Open Chrome and go to `chrome://extensions/`
33-
5. Enable "Developer mode" in the top right
34-
6. Click "Load unpacked" and select the extension directory
35-
7. Click the extension icon and set your OpenAI API key in the settings
23+
1. Download the latest release package (`web-reader.zip`) from the [Releases](https://github.com/cyberelf/web-reader/releases) page
24+
2. Extract the zip file to a local directory
25+
3. Open Chrome and go to `chrome://extensions/`
26+
4. Enable "Developer mode" in the top right
27+
5. Click "Load unpacked" and select the extracted directory
28+
6. Click the extension icon and set your OpenAI API key in the settings
3629

3730
## Usage
3831

@@ -47,6 +40,20 @@ A Chrome extension that allows you to ask questions about web page content, imag
4740

4841
## Development
4942

43+
### Setup
44+
1. Clone this repository
45+
2. Install dependencies:
46+
```bash
47+
npm install
48+
```
49+
3. Build the extension:
50+
```bash
51+
npm run build
52+
```
53+
4. Open Chrome and go to `chrome://extensions/`
54+
5. Enable "Developer mode" in the top right
55+
6. Click "Load unpacked" and select the `dist` directory
56+
5057
The extension is built with TypeScript for enhanced type safety and better development experience.
5158

5259
### Project Structure

0 commit comments

Comments
 (0)