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.
This commit is contained in:
n4ze3m 2024-10-13 18:22:08 +05:30
parent d83ba79035
commit 4e04155471
2 changed files with 22 additions and 29 deletions

View File

@ -1,4 +1,3 @@
# Contributing to Page Assist # 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. 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.

View File

@ -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) [![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/) [![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): Checkout the Demo (v1.0.0):
<div align="center"> <div align="center">
@ -30,15 +29,13 @@ Checkout the Demo (v1.0.0):
want more features? Create an issue and let me know. want more features? Create an issue and let me know.
### Manual Installation ### Manual Installation
#### Pre-requisites #### Pre-requisites
- Node.js (v18 or higher) - [Installation Guide](https://nodejs.org) - Bun - [Installation Guide](https://bun.sh/)
- npm
- Ollama (Local AI Provider) - [Installation Guide](https://ollama.com) - Ollama (Local AI Provider) - [Installation Guide](https://ollama.com)
- Any OpenAI API Compatible Endpoint (like LM Studio, llamafile etc.)
1. Clone the repository 1. Clone the repository
@ -50,19 +47,19 @@ cd page-assist
2. Install the dependencies 2. Install the dependencies
```bash ```bash
npm install bun install
``` ```
3. Build the extension (by default it will build for Chrome) 3. Build the extension (by default it will build for Chrome)
```bash ```bash
npm run build bun run build
``` ```
or you can build for Firefox or you can build for Firefox
```bash ```bash
npm run build:firefox bun build:firefox
``` ```
4. Load the extension (chrome) 4. Load the extension (chrome)
@ -101,7 +98,7 @@ 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. You can run the extension in development mode to make changes and test them.
```bash ```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. 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.
@ -109,34 +106,32 @@ This will start a development server and watch for changes in the source files.
## Browser Support ## Browser Support
| Browser | Sidebar | Chat With Webpage | Web UI | | Browser | Sidebar | Chat With Webpage | Web UI |
| -------- | ------- | ----------------- | ------ | | ----------- | ------- | ----------------- | ------ |
| Chrome | ✅ | ✅ | ✅ | | Chrome | ✅ | ✅ | ✅ |
| Brave | ✅ | ✅ | ✅ | | Brave | ✅ | ✅ | ✅ |
| Firefox | ✅ | ✅ | ✅ | | Firefox | ✅ | ✅ | ✅ |
| Vivaldi | ✅ | ✅ | ✅ | | Vivaldi | ✅ | ✅ | ✅ |
| Edge | ✅ | ❌ | ✅ | | Edge | ✅ | ❌ | ✅ |
| LibreWolf | ✅ | ✅ | ✅ |
| Zen Browser | ✅ | ✅ | ✅ |
| Opera | ❌ | ❌ | ✅ | | Opera | ❌ | ❌ | ✅ |
| Arc | ❌ | ❌ | ✅ | | Arc | ❌ | ❌ | ✅ |
## Local AI Provider ## Local AI Provider
- [Ollama](https://github.com/ollama/ollama) - [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 ## Roadmap
- [X] Firefox Support - [x] Firefox Support
- [ ] Code Completion support for Web based IDEs (like Colab, Jupyter, etc.) - [x] More Local AI Providers
- [ ] More Local AI Providers
- [ ] More Customization Options - [ ] More Customization Options
- [ ] Better UI/UX - [ ] Better UI/UX
## Privacy ## 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.
@ -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. or you can sponsor me on GitHub.
## Blogs and Videos About Page Assist ## 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. 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.