diff --git a/README.md b/README.md index fbb108a..a2e8fe2 100644 --- a/README.md +++ b/README.md @@ -8,3 +8,23 @@ Uses OCR Space's [free OCR API](https://ocr.space/ocrapi). ### *V1.0* Selects image tag, converts it into base64, passes it to a POST call for the OCR API, parses returned information, fills in the form element. + +## Installation + +1. Download this repository as a zip file (either using the green 'Code' button or the releases tab on the right) and extract it anywhere. +2. Go to [chrome://extensions](chrome://extensions) to manage your extensions. +3. Enable **Developer Mode** by clicking the toggle switch next to Developer mode. +4. Click the **Load unpacked** button and select the extension directory that you just unzipped. + +## Usage + +On every instance of https://www.iiserpune.in/sam/roott/index.php that you open in Chrome, this extension will fill out the OCR result in the appropriate form field. +The OCR results are not always perfect. +edit line28 of auto-login.js to replace the API Key with your own API Key, if you'd like. + +## Improvements + +- [ ] Icons for the extension +- [ ] Loading gif while the answer hasn't been returned yet +- [ ] Error notif if the API call was bad or an answer wasn't returned +- [ ] Option for user to toggle on "Autosubmit form" (autosubmits form after the answer is filled in)