diff options
| author | James Campos <james.r.campos@gmail.com> | 2020-05-18 04:08:38 -0700 |
|---|---|---|
| committer | James Campos <james.r.campos@gmail.com> | 2020-05-18 04:08:38 -0700 |
| commit | e531a1c2d60074de5cc731ea563a4709d8abc1a2 (patch) | |
| tree | f181005a8df8d82040357fb3d5ee3c243b06c102 /README.md | |
| parent | ee86ec32fd89b568d7294a4310550e819ca8657e (diff) | |
| download | bk-e531a1c2d60074de5cc731ea563a4709d8abc1a2.tar.gz | |
crates
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 24 |
1 files changed, 17 insertions, 7 deletions
@@ -1,22 +1,32 @@ # bk bk is a WIP terminal Epub reader, written in Rust. +# Features +- Cross platform - Linux, macOS and Windows support +- Single binary, instant startup +- Epub 2/3 support +- Incremental search +- Vim bindings + # Usage +Install from crates.io: + + cargo install bk + +or from github: + + git clone https://github.com/aeosynth/bk cargo install --path . + +then run: + bk path/to/epub Type <kbd>F1</kbd> or <kbd>?</kbd> to see the commands. Running `bk` without an argument will load the most recent Epub. -# Features -- Cross platform - Linux, macOS and Windows support -- Single binary, instant startup -- Epub 2/3 support -- Incremental search -- Vim bindings - # TODO - configuration - links |