diff options
| -rw-r--r-- | Cargo.lock | 18 | ||||
| -rw-r--r-- | Cargo.toml | 2 | ||||
| -rw-r--r-- | README.md | 22 |
3 files changed, 20 insertions, 22 deletions
@@ -2,9 +2,9 @@ # It is not intended for manual editing. [[package]] name = "adler" -version = "0.2.2" +version = "0.2.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ccc9a9dd069569f212bc4330af9f17c4afb5e8ce185e83dbb14f1349dda18b10" +checksum = "ee2a4ec343196209d6594e19543ae87a39f96d5534d7174822a3ad825dd6ed7e" [[package]] name = "anyhow" @@ -61,7 +61,7 @@ checksum = "cf1de2fe8c75bc145a2f577add951f8134889b4795d47466a54a5c846d691693" [[package]] name = "bk" -version = "0.3.0" +version = "0.4.1" dependencies = [ "anyhow", "argh", @@ -98,9 +98,9 @@ dependencies = [ [[package]] name = "crossterm" -version = "0.17.6" +version = "0.17.7" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b1f397c213f41eae56e512bb3bec44ac044650e30f1a15357d9d8495a01906cb" +checksum = "6f4919d60f26ae233e14233cc39746c8c8bb8cd7b05840ace83604917b51b6c7" dependencies = [ "bitflags", "crossterm_winapi", @@ -264,9 +264,9 @@ dependencies = [ [[package]] name = "redox_syscall" -version = "0.1.56" +version = "0.1.57" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "2439c63f3f6139d1b57529d16bc3b8bb855230c8efcc5d3a896c8bea7c3b1e84" +checksum = "41cc0f7e4d5d4544e8861606a285bb08d3e70712ccc7d2b84d7c0ccfaf4b05ce" [[package]] name = "ron" @@ -355,9 +355,9 @@ dependencies = [ [[package]] name = "syn" -version = "1.0.33" +version = "1.0.34" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e8d5d96e8cbb005d6959f119f773bfaebb5684296108fb32600c00cde305b2cd" +checksum = "936cae2873c940d92e697597c5eee105fb570cd5689c695806f672883653349b" dependencies = [ "proc-macro2", "quote", @@ -1,6 +1,6 @@ [package] name = "bk" -version = "0.3.0" +version = "0.4.1" authors = ["James Campos <james.r.campos@gmail.com>"] edition = "2018" license = "MIT" @@ -1,13 +1,14 @@ # bk -bk is a WIP terminal Epub reader, written in Rust. +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 +- EPUB 2/3 support - Vim bindings - Incremental search - Bookmarks +- Inline styles (bold/italic) # Install Install from crates.io: @@ -31,21 +32,20 @@ or from github: -w, --width characters per line --help display usage information -Running `bk` without a path will load the most recent Epub. +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 +Check if your terminal supports italics: -- Theming: theme your terminal -- Config file: create an alias with cli options + echo -e "\e[3mitalic\e[0m" # Comparison | | bk | epr/epy | | - | - | - | | language | rust | python | -| runtime deps | none | python, curses | -| styled tags | see 1 | :x: | +| runtime deps | :x: | python, curses | +| inline styles | :heavy_check_mark: | :x: | | incremental search | :heavy_check_mark: | :x: | | multi line search | :heavy_check_mark: | :x: | | regex search | :x: | :heavy_check_mark: | @@ -54,11 +54,9 @@ Type any function key (eg <kbd>F1</kbd>) to see the keybinds. | themes | :x: | :heavy_check_mark: | | choose file from history | :x: | :heavy_check_mark: | | additional formats | :x: | FictionBook | -| external integration | see 2 | dictionary | +| external integration | see 1 | dictionary | -1: headers (h1-h6) are bolded - -2: you can use the `--meta` switch to use `bk` as a file previewer with eg [nnn](https://github.com/jarun/nnn/) +1: you can use the `--meta` switch to use `bk` as a file previewer with eg [nnn](https://github.com/jarun/nnn/) # Inspiration <https://github.com/wustho/epr> |