Skip to content

Commit

Permalink
crates
Browse files Browse the repository at this point in the history
  • Loading branch information
aeosynth committed May 18, 2020
1 parent ee86ec3 commit e531a1c
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 8 deletions.
5 changes: 4 additions & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,10 1,13 @@
[package]
name = "bk"
version = "0.1.0"
version = "0.1.1"
authors = ["James Campos <[email protected]>"]
edition = "2018"
license = "MIT"
description = "Terminal Epub reader"
keywords = ["ebook", "epub"]
categories = ["command-line-utilities"]
readme = "README.md"
repository = "https://github.com/aeosynth/bk"

[dependencies]
Expand Down
24 changes: 17 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit e531a1c

Please sign in to comment.