aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJames Campos <james.r.campos@gmail.com>2020-06-17 14:45:46 -0700
committerJames Campos <james.r.campos@gmail.com>2020-06-17 14:45:46 -0700
commit07aff0373a25ee7ad7b4da10b30207dde3fb29ec (patch)
treee6c9ace47f4b2029bcd8f51cc7e74c6104f6e3b0 /README.md
parent82b332a546b0946cde8975b4ed5b5c3b702316c1 (diff)
downloadbk-07aff0373a25ee7ad7b4da10b30207dde3fb29ec.tar.gz
0.2
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 15 insertions, 2 deletions
diff --git a/README.md b/README.md
index ddae722..328b43e 100644
--- a/README.md
+++ b/README.md
@@ -20,16 +20,29 @@ or from github:
cargo install --path bk
# Usage
- bk [<path>] [-w <width>]
+
+ Usage: bk [<path>] [-w <width>]
+
+ read a book
+
+ Options:
+ -w, --width characters per line
+ --help display usage information
Running `bk` without a path will load the most recent Epub.
Type any function key (eg <kbd>F1</kbd>) to see the keybinds.
+# Configuration alternatives
+
+- Theming: theme your terminal
+- Config file: create an alias with cli options
+
# TODO
- more configuration
- better html support
-- better unicode support
+- test unicode
+- github actions / ci
- css?
- mobi?