From 442b4958f6838b2ee1a6e9993ff79f2640d8a8f6 Mon Sep 17 00:00:00 2001 From: Lauchmelder Date: Sat, 19 Mar 2022 20:10:37 +0100 Subject: [PATCH] added readme --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..207f0de --- /dev/null +++ b/README.md @@ -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. \ No newline at end of file