aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: aefe1ee4ff1ea81aeed0bed95760d8ae975149ba (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# bk
bk is a terminal Epub reader. Currently only Linux is tested, but macOS and Windows support is planned.

# Usage

    cargo install --path .
    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
- 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
<https://github.com/wustho/epr>