From 4e04155471cf4ac8909580e2d511e0e33000b55b Mon Sep 17 00:00:00 2001 From: n4ze3m Date: Sun, 13 Oct 2024 18:22:08 +0530 Subject: [PATCH] Fix: Update dependencies and documentation Updated dependencies to use Bun for package management and updated documentation to reflect the changes. Also updated the browser compatibility list to include LibreWolf and Zen Browser. --- CONTRIBUTING.md | 1 - README.md | 50 ++++++++++++++++++++++--------------------------- 2 files changed, 22 insertions(+), 29 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 54d889d..c37131c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,3 @@ - # Contributing to Page Assist Thank you for your interest in contributing to Page Assist! We welcome contributions from anyone, whether it's reporting bugs, suggesting improvements, or submitting code changes. diff --git a/README.md b/README.md index 750271b..d659a0b 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,6 @@ Page Assist supports Chromium-based browsers like Chrome, Brave, Edge, and Firef [![Chrome Web Store](https://pub-35424b4473484be483c0afa08c69e7da.r2.dev/UV4C4ybeBTsZt43U4xis.png)](https://chrome.google.com/webstore/detail/page-assist/jfgfiigpkhlkbnfnbobbkinehhfdhndo) [![Firefox Add-on](https://pub-35424b4473484be483c0afa08c69e7da.r2.dev/get-the-addon.png)](https://addons.mozilla.org/en-US/firefox/addon/page-assist/) - Checkout the Demo (v1.0.0):
@@ -30,15 +29,13 @@ Checkout the Demo (v1.0.0): want more features? Create an issue and let me know. - ### Manual Installation #### Pre-requisites -- Node.js (v18 or higher) - [Installation Guide](https://nodejs.org) -- npm +- Bun - [Installation Guide](https://bun.sh/) - Ollama (Local AI Provider) - [Installation Guide](https://ollama.com) - +- Any OpenAI API Compatible Endpoint (like LM Studio, llamafile etc.) 1. Clone the repository @@ -50,19 +47,19 @@ cd page-assist 2. Install the dependencies ```bash -npm install +bun install ``` 3. Build the extension (by default it will build for Chrome) ```bash -npm run build +bun run build ``` or you can build for Firefox ```bash -npm run build:firefox +bun build:firefox ``` 4. Load the extension (chrome) @@ -101,45 +98,43 @@ Note: You can change the keyboard shortcuts from the extension settings on the C You can run the extension in development mode to make changes and test them. ```bash -npm run dev +bun dev ``` This will start a development server and watch for changes in the source files. You can load the extension in your browser and test the changes. ## Browser Support -| Browser | Sidebar | Chat With Webpage | Web UI | -| -------- | ------- | ----------------- | ------ | -| Chrome | ✅ | ✅ | ✅ | -| Brave | ✅ | ✅ | ✅ | -| Firefox | ✅ | ✅ | ✅ | -| Vivaldi | ✅ | ✅ | ✅ | -| Edge | ✅ | ❌ | ✅ | -| Opera | ❌ | ❌ | ✅ | -| Arc | ❌ | ❌ | ✅ | - - +| Browser | Sidebar | Chat With Webpage | Web UI | +| ----------- | ------- | ----------------- | ------ | +| Chrome | ✅ | ✅ | ✅ | +| Brave | ✅ | ✅ | ✅ | +| Firefox | ✅ | ✅ | ✅ | +| Vivaldi | ✅ | ✅ | ✅ | +| Edge | ✅ | ❌ | ✅ | +| LibreWolf | ✅ | ✅ | ✅ | +| Zen Browser | ✅ | ✅ | ✅ | +| Opera | ❌ | ❌ | ✅ | +| Arc | ❌ | ❌ | ✅ | ## Local AI Provider - [Ollama](https://github.com/ollama/ollama) -- Chrome AI (Gemini Nano) +- Chrome AI (Gemini Nano) -More providers will be added in the future. +- OpenAI API Compatible endpoints (like LM Studio, llamafile etc.) ## Roadmap -- [X] Firefox Support -- [ ] Code Completion support for Web based IDEs (like Colab, Jupyter, etc.) -- [ ] More Local AI Providers +- [x] Firefox Support +- [x] More Local AI Providers - [ ] More Customization Options - [ ] Better UI/UX - ## Privacy -Page Assist does not collect any personal data. The only time the extension communicates with the server is when you are using the share feature, which can be disabled from the settings. +Page Assist does not collect any personal data. The only time the extension communicates with the server is when you are using the share feature, which can be disabled from the settings. All the data is stored locally in the browser storage. You can view the source code and verify it yourself. @@ -155,7 +150,6 @@ If you like the project and want to support it, you can buy me a coffee. It will or you can sponsor me on GitHub. - ## Blogs and Videos About Page Assist This are some of the blogs and videos about Page Assist. If you have written a blog or made a video about Page Assist, feel free to create a PR and add it here.