From 44dd95c4942f491966d7fd4a9b35d1f67ab30598 Mon Sep 17 00:00:00 2001 From: n4ze3m Date: Mon, 13 May 2024 13:15:19 +0530 Subject: [PATCH] chore: Update README with manual installation instructions for Ollama --- README.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a226cb4..e926ffd 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,13 @@ Note: You can install the extension on any Chromium-based browser. It is not lim ### Manual Installation +#### Pre-requisites + +- Node.js (v18 or higher) +- npm +- Ollama (Local AI Provider) + + 1. Clone the repository ```bash @@ -43,13 +50,19 @@ cd page-assist npm install ``` -3. Build the extension +3. Build the extension (by default it will build for Chrome) ```bash npm run build ``` -4. Load the extension +or you can build for Firefox + +```bash +npm run build:firefox +``` + +4. Load the extension (chrome) - Open the Extension Management page by navigating to `chrome://extensions`. @@ -57,6 +70,13 @@ npm run build - Click the `Load unpacked` button and select the `build` directory. +5. Load the extension (firefox) + +- Open the Add-ons page by navigating to `about:addons`. +- Click the `Extensions` tab. +- Click the `Manage Your Extensions` button. +- Click the `Load Temporary Add-on` button and select the `manifest.json` file from the `build` directory. + ## Usage ### Sidebar