added readme

This commit is contained in:
Lauchmelder 2022-03-19 20:10:37 +01:00
parent b9acf06be5
commit 442b4958f6
No known key found for this signature in database
GPG key ID: C2403C69D78F011D

11
README.md Normal file
View file

@ -0,0 +1,11 @@
# FuriKani
A chrome extension to remove furigana from websites based on your WaniKani level.
## Installation
This extension is not on the web store (yet). Download the repo and go to your extensions page in chrome (`chrome://extensions`). Enable the developer mode and add the root folder of this project as an unpacked extension.
## How to use
Click the extension icon in your extension bar and enter a WaniKani API Token into the field. Then click "Download Data". That's it, the extension will now remove furigana of any vocab you (should) know.
There are known issues that I'm working on fixing.