Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
realtomkwok committed Sep 16, 2024
1 parent 499c805 commit f19218b
Showing 1 changed file with 21 additions and 19 deletions.
40 changes: 21 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,13 @@

Clara is a Chrome extension designed to enhance web navigation by providing AI-powered insights and assistance.

## Building the Extension
## Usage

1. Ensure you have Node.js and npm installed.
2. Clone the repository and navigate to the project directory.
3. Install dependencies:
```shell
npm install
```
4. Build the production extension:
```shell
npm run build
```

This will create a `dist` directory with the compiled extension.

## Installing the Chrome Extension

1. Open Google Chrome and go to `chrome://extensions/`.
2. Drag and drop the `build` directory created in the build step.
3. The extension should now be installed and ready to use.
1. Download the release ZIP file from the [Releases](https://github.com/realtomkwok/capstone-998/releases) page.
2. Unzip the file on your computer.
3. Open Google Chrome and go to `chrome://extensions/`.
4. Drag and drop the unzipped folder into the extensions page.
5. And you're ready to use Clara!

OR manually load the extension:

Expand All @@ -34,6 +21,21 @@ OR manually load the extension:
- Use `npm run watch` for development with hot-reloading.
- Run `npm run format` to format code using Prettier.

### Building the Extension

1. Ensure you have Node.js and npm installed.
2. Clone the repository and navigate to the project directory.
3. Install dependencies:
```shell
npm install
```
4. Build the production extension:
```shell
npm run build
```

This will create a `build` directory with the compiled extension.

## Packaging

To create a ZIP file for distribution:
Expand Down

0 comments on commit f19218b

Please sign in to comment.