wanikani-i3blocks

an i3blocks block to display Wanikani stats
Log | Files | Refs | README | LICENSE

README.md (1174B)

      1 # i3blocks Script for Wanikani
      2 
      3 This is a script for i3blocks that fetches your current status from Wanikani
      4 and displays it in the i3 status bar.
      5 
      6 It displays the number of open lessons / reviews as well as how many
      7 kanji and words you have already learnt (level Guru or higher).
      8 
      9 
     10 ## Screenshot
     11 
     12 ![Wanikani i3 Status](screenshot.png)
     13 
     14 The screenshot shows that I have 30 new lessons available and 44 open reviews.
     15 I already learnt 208 kanji and 517 words with Wanikani.
     16 
     17 
     18 ## Usage
     19 
     20 To use it you have to specify your Wanikani token (ideally a read-only token)
     21 in a user variable called `$WANIKANI_TOKEN`. How you do this depends on your
     22 setup. For example I define my environment variables in `.xinitrc`, because
     23 I start my desktop with `startx` which executes `.xinitrc`.
     24 
     25 If you cannot find out how to setup an environment variable that's available
     26 within your window manager, just edit the `wanikani` script and add
     27 `WANIKANI_TOKEN=<your-token>` to the beginning.
     28 
     29 Next, create a block configuration in your `i3blocks.conf`:
     30 
     31 ```
     32 [wanikani]
     33 command=~/wanikani-i3blocks/wanikani
     34 label=WK
     35 interval=1800
     36 ```
     37 
     38 You'll have to adjust `command` to where you saved `wanikani`.