https://github.com/jigar-dhulla/proofread-chrome-extension
Proofread any content in textarea field with OpenAI
https://github.com/jigar-dhulla/proofread-chrome-extension
Last synced: 4 days ago
JSON representation
Proofread any content in textarea field with OpenAI
- Host: GitHub
- URL: https://github.com/jigar-dhulla/proofread-chrome-extension
- Owner: jigar-dhulla
- Created: 2025-04-06T16:14:39.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2025-04-06T16:32:45.000Z (about 1 month ago)
- Last Synced: 2025-05-11T10:51:04.254Z (8 days ago)
- Language: JavaScript
- Size: 76.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Proofread Chrome Extension
This Chrome extension helps you proofread text in any `textarea` or `input[type="text"]` field on the web. It uses the OpenAI API to provide grammar, spelling, and punctuation corrections.
## Features
* **Real-time Proofreading:** Get proofreading suggestions directly within your text fields.
* **OpenAI Integration:** Leverages the power of OpenAI's language models for accurate corrections.
* **Easy to Use:** Simple button interface integrated into text fields.
* **Accept/Reject Suggestions:** Review suggestions and choose to accept or reject them.
* **User-Configurable API Key:** Users can enter their own OpenAI API key for personalized usage.
## Installation
1. **Clone the Repository:**
```bash
git clone [email protected]:jigar-dhulla/proofread-chrome-extension.git
```
2. **Open Chrome Extensions:**
* In your Chrome browser, go to `chrome://extensions/`.
3. **Enable Developer Mode:**
* Turn on "Developer mode" in the top right corner.
4. **Load Unpacked Extension:**
* Click the "Load unpacked" button.
* Select the directory where you cloned the repository.
## Usage
1. **Enter Text:** Go to any website with a `textarea` or `input[type="text"]` field.
2. **Proofread Button:** A "Proofread" button will appear next to the text field when you focus on it.
3. **Click Proofread:** Click the "Proofread" button.
4. **Review Suggestions:** A modal will appear with the original text and the suggested corrections.
5. **Accept or Close:**
* Click "Accept" to replace the original text with the suggested text.
* Click "Close" to dismiss the modal without making changes.
## Configuration
1. **Open Extension Settings:**
* Click on the extension icon in your Chrome toolbar.
* Click on the "Open Settings" button.
2. **Enter API Key:**
* Enter your OpenAI API key in the provided field.
3. **Save:**
* Click the "Save" button.
## Project Structure
```
proofread-chrome-extension/
├── background.js
├── content.js
├── options.html
├── options.js
├── popup.html
├── popup.js
├── styles.css
├── manifest.json
└── README.md
```
## Dependencies
* **OpenAI API:** This extension requires an OpenAI API key to function.
## Contributing
If you'd like to contribute to this project, please follow these steps:
1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them.
4. Push your changes to your fork.
5. Submit a pull request.
## License
MIT
## Contact
If you have any questions or suggestions, feel free to open an issue on the repository.