feat(core): Update README.md (Commit #1)
Swadhin Biswas committed 7 months ago
448edaa
1 parent 5abfa9d
commit 448edaa
1 file changed
+38 -31
Showing 1 changed file+38-28
▼README.md
+38-28
| @@ -1,43 +1,50 @@ | ||
1 | -# 🪶 OpenGrammar | |
1 | +<div align="center"> | |
2 | + <img src="logo.svg" alt="OpenGrammar Logo" width="120" height="120"> | |
3 | + | |
4 | + # 🪶 OpenGrammar | |
2 | 5 | |
3 | -**Your privacy-first, open-source writing assistant.** | |
6 | + **Your privacy-first, open-source writing assistant.** | |
7 | + *The free, self-hostable Grammarly alternative.* | |
4 | 8 | |
5 | -OpenGrammar is a powerful, self-hostable browser extension that helps you write clearly and confidently everywhere on the web. It's built to feel like the premium writing assistants you know, but with a critical difference: **you control your data, and it can run completely for free.** | |
9 | + [](https://opensource.org/licenses/Apache-2.0) | |
10 | + [](http://makeapullrequest.com) | |
11 | + [](https://reactjs.org/) | |
12 | + [](https://vitejs.dev/) | |
13 | +</div> | |
6 | 14 | |
7 | 15 | --- |
8 | 16 | |
17 | +OpenGrammar is a powerful, self-hostable browser extension that helps you write clearly and confidently everywhere on the web. It's built to feel like the premium writing assistants you know, but with a critical difference: **you control your data, and it can run completely for free.** | |
18 | + | |
9 | 19 | ## 🌟 Why OpenGrammar? |
10 | 20 | |
11 | 21 | Most popular grammar assistants require you to send every keystroke to their servers and charge a hefty monthly fee for advanced features. OpenGrammar changes that: |
12 | 22 | |
13 | -1. **Zero Cost Option:** The core engine runs locally in your browser, checking for passive voice, repetition, and readability without needing a server or an internet connection. | |
14 | -2. **Bring Your Own AI:** Want advanced, context-aware grammar corrections? Just paste in your own API key (like OpenAI, Groq, or OpenRouter). You pay only fractions of a cent for what you actually use, directly to the AI provider. | |
15 | -3. **Absolute Privacy:** We don't have a database. We don't have user accounts. Your API key never leaves your browser. If you use the AI features, your text is sent securely to a stateless edge function, processed, and immediately forgotten. | |
16 | -4. **Open Source & Self-Hosted:** You can deploy the backend to Cloudflare Workers or Vercel Edge for free in one command. You own the infrastructure. | |
23 | +1. **Zero Cost Option:** The core engine runs locally in your browser, checking for passive voice, repetition, and readability without needing a server or an internet connection. | |
24 | +2. **Bring Your Own AI:** Want advanced, context-aware grammar corrections? Just paste in your own API key (like OpenAI, Groq, or OpenRouter). You pay only fractions of a cent for what you actually use, directly to the AI provider. | |
25 | +3. **Absolute Privacy:** We don't have a database. We don't have user accounts. Your API key never leaves your browser. If you use the AI features, your text is sent securely to a stateless edge function, processed, and immediately forgotten. | |
26 | +4. **Open Source & Self-Hosted:** You can deploy the backend to Cloudflare Workers or Vercel Edge for free in one command. You own the infrastructure. | |
17 | 27 | |
18 | 28 | ## ✨ Features |
19 | 29 | |
20 | -- **Works Everywhere:** Seamlessly integrates into text inputs, textareas, and rich text editors (like Gmail, Google Docs, Notion, and Reddit). | |
21 | -- **Blazing Fast:** Built with modern web technologies (React, Vite, Manifest V3) for minimal performance impact. | |
22 | -- **Dual-Engine Architecture:** | |
23 | - - *Rule-Based (Free & Offline):* Catches passive voice, repeated words, and overly long sentences. | |
24 | - - *AI-Powered (Requires API Key):* Advanced grammar, spelling, clarity, and stylistic suggestions using models like GPT-4 or open-source alternatives via OpenRouter. | |
25 | -- **Intuitive UI:** Familiar red, yellow, and blue underlines with click-to-apply suggestions. | |
26 | -- **Customizable:** Toggle the extension on or off per website, choose your preferred AI model, and manage your privacy settings. | |
27 | - | |
30 | +- **Works Everywhere:** Seamlessly integrates into text inputs, textareas, and rich text editors (like Gmail, Google Docs, Notion, and Reddit). | |
31 | +- **Blazing Fast:** Built with modern web technologies (React, Vite, Manifest V3) for minimal performance impact. | |
32 | +- **Dual-Engine Architecture:** | |
33 | + - *Rule-Based (Free & Offline):* Catches passive voice, repeated words, and overly long sentences. | |
34 | + - *AI-Powered (Requires API Key):* Advanced grammar, spelling, clarity, and stylistic suggestions using models like GPT-4, Groq, Together, or open-source alternatives via OpenRouter and Ollama. | |
35 | +- **Tone & Style Rewriting:** Right-click context menus or shortcuts to quickly rewrite text in 8 different tones (Formal, Casual, Professional, etc.). | |
36 | +- **Writing Statistics:** Built-in dashboard for readability scores, reading time, and vocabulary diversity. | |
37 | +- **Intuitive UI:** Familiar red, yellow, and blue underlines with click-to-apply suggestions. | |
28 | 38 | |
29 | 39 | ## 🚀 Getting Started (For Users) |
30 | 40 | |
31 | 41 | *Note: Since this is an open-source developer project, it is not yet published on the Chrome Web Store. You will need to load it manually.* |
32 | 42 | |
33 | -1. **Download the Extension:** Download the latest release from the [Releases page] (or build it from source following the Developer guide below). | |
34 | -2. **Open Extensions Page:** In Chrome, go to `chrome://extensions/`. | |
35 | -3. **Enable Developer Mode:** Toggle the switch in the top right corner. | |
36 | -4. **Load Unpacked:** Click the "Load unpacked" button and select the `opengrammar/extension/dist` folder you downloaded. | |
37 | -5. **Configure:** Click the OpenGrammar icon in your browser toolbar. If you want advanced AI features, paste your OpenAI or OpenRouter API key here. It is saved locally on your device. | |
38 | - | |
43 | +1. **Download the Extension:** Download the latest release or clone this repository. | |
44 | +2. **Open Extensions Page:** In Chrome, go to `chrome://extensions/`. | |
45 | +3. **Enable Developer Mode:** Toggle the switch in the top right corner. | |
46 | +4. **Load Unpacked:** Click the "Load unpacked" button and select the `opengrammar/extension/dist` folder you built or downloaded. | |
47 | +5. **Configure:** Click the OpenGrammar icon in your browser toolbar. Paste your OpenAI, Groq, or OpenRouter API key to enable advanced AI capabilities. | |
39 | 48 | |
40 | 49 | ## 💻 Developer Guide: Build & Deploy |
41 | 50 | |
| @@ -45,12 +52,12 @@ Want to build OpenGrammar from scratch or deploy your own backend? Here is how. | ||
45 | 52 | |
46 | 53 | ### Prerequisites |
47 | 54 | |
48 | -- Node.js (v18 or newer) | |
49 | -- npm, pnpm, or yarn | |
55 | +- Node.js (v18 or newer) | |
56 | +- npm, pnpm, or yarn | |
50 | 57 | |
51 | 58 | ### 1. Set up the Backend (Serverless Edge API) |
52 | 59 | |
53 | -The backend is a lightweight API that securely handles the AI requests. It's designed to run on Cloudflare Workers (or Vercel Edge), which are incredibly fast and offer generous free tiers. | |
60 | +The backend is a lightweight API that securely handles the AI requests. | |
54 | 61 | |
55 | 62 | ```bash |
56 | 63 | # Navigate to the backend folder |
| @@ -77,19 +84,19 @@ cd opengrammar/extension | ||
77 | 84 | npm install |
78 | 85 | |
79 | 86 | # IMPORTANT: Link your Backend |
80 | -# Open src/background/index.ts and replace the BACKEND_URL with your deployed URL from step 1 (or leave as localhost for local testing). | |
87 | +# Open src/background/index.ts and replace the BACKEND_URL with your deployed URL from step 1. | |
81 | 88 | |
82 | 89 | # Build the extension |
83 | 90 | npm run build |
84 | 91 | ``` |
85 | 92 | |
86 | -This will create a `dist/` folder. Load this folder into Chrome following the "Getting Started (For Users)" instructions above. | |
87 | - | |
93 | +This will create a `dist/` folder. Load this folder into Chrome following the user instructions above. | |
88 | 94 | |
89 | 95 | ## 🤝 Contributing |
90 | 96 | |
91 | -OpenGrammar is a community effort! Whether you want to add new local grammar rules, improve the highlighting logic in rich text editors, or fix bugs, we welcome your contributions. Please check out our `ROADMAP.md` for inspiration. | |
97 | +OpenGrammar is a community effort! Whether you want to add new local grammar rules, improve the highlighting logic in rich text editors, or fix bugs, we welcome your contributions. | |
98 | + | |
99 | +Please check out our `ROADMAP.md` to see what we are currently working on. | |
92 | 100 | |
93 | 101 | ## 📄 License |
94 | 102 | |
95 | 103 | |