diff --git a/README.md b/README.md index 80c3a37..b5e1255 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,34 @@ -# FPTU-FAP-Toolkits -FPTU FAP Toolkits +# FPTU-Toolkits +**FPTU Toolkits** is one collection of tools for FPTU students. Delivered as a Chrome Extension, it will help you save time when studying at FPTU. +Some key features: +- Auto login to FPTU FAP Website. +- Auto finish feedback form. + +## Installation +1. Download the latest release from [here](https://github.com/fu-js/FPTU-Toolkits/releases). +2. Unzip the downloaded file. +3. Open Chrome and go to `chrome://extensions/`. +4. Enable `Developer mode` on the top right corner. +5. Click `Load unpacked` and select the unzipped folder. +6. Enjoy! + +## Usage +### Auto login to FPTU FAP Website + +1. Click on the extension icon on the top right corner of Chrome. +2. Enter your student email. +3. Click `Save`. +4. Every time you visit FPTU FAP Website, you will be automatically logged in. + +### Auto finish feedback form + +Every time you visit a feedback form, it will be automatically filled with fixed answers. Then will automatically be submitted. + +## Authors +- Members of [JS Club](https://github.com/fu-js). + +## Contributing +Feel free to contribute to this project. Any contributions you make are greatly appreciated. + +## License +This project is licensed under the Apache License - see the [LICENSE](LICENSE) file for details.