aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md17
1 files 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 [<path>] [-w <width>]
Running `bk` without a path will load the most recent Epub.
-The `-w` flag sets the line width.
-
-Type any function key (eg <kbd>F1</kbd>) to see the commands.
+Type any function key (eg <kbd>F1</kbd>) to see the keybinds.
# TODO
-- configuration
+- more configuration
- better html support
- better unicode support
-- mobi?
- css?
-- gui?
+- mobi?
# Inspiration
<https://github.com/wustho/epr>