From cd826f78e107d30d38925f5614d7f90fd30b287e Mon Sep 17 00:00:00 2001 From: James Campos Date: Sun, 14 Jun 2020 12:26:40 -0700 Subject: readme --- README.md | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 3eede5d..ddae722 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,7 @@ bk is a WIP terminal Epub reader, written in Rust. - Incremental search - Bookmarks -# Usage - +# Install Install from crates.io: cargo install bk @@ -20,23 +19,19 @@ or from github: git clone https://github.com/aeosynth/bk cargo install --path bk -then run: - - bk [flags] [path] +# Usage + bk [] [-w ] Running `bk` without a path will load the most recent Epub. -The `-w` flag sets the line width. - -Type any function key (eg F1) to see the commands. +Type any function key (eg F1) to see the keybinds. # TODO -- configuration +- more configuration - better html support - better unicode support -- mobi? - css? -- gui? +- mobi? # Inspiration -- cgit v1.2.3