From d09560fa20287e5033cca5229649eac140f81e63 Mon Sep 17 00:00:00 2001 From: James Campos Date: Sat, 16 May 2020 02:22:35 -0700 Subject: meta --- README.md | 25 +++++++++++++++++++++---- 1 file changed, 21 insertions(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 5c00a80..aefe1ee 100644 --- a/README.md +++ b/README.md @@ -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 F1 or ? to see the commands. -type ? 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 -- cgit v1.2.3