diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 25 |
1 files changed, 21 insertions, 4 deletions
@@ -1,13 +1,30 @@ # bk -bk is a WIP terminal epub reader. currently only tested on linux. +bk is a terminal Epub reader. Currently only Linux is tested, but macOS and Windows support is planned. -# install +# Usage cargo install --path . + bk path/to/epub -# usage +Type <kbd>F1</kbd> or <kbd>?</kbd> to see the commands. -type <kbd>?</kbd> to see the commands +Running `bk` without an argument will load the most recent Epub. + +# Features +- Single binary, instant startup +- Epub 2/3 support +- Incremental search +- Vim bindings + +# TODO +- macOS, Windows +- configuration +- links +- better unicode support +- better html rendering +- mobi? +- css? +- gui? # inspiration <https://github.com/wustho/epr> |