aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--Cargo.toml5
-rw-r--r--README.md24
2 files changed, 21 insertions, 8 deletions
diff --git a/Cargo.toml b/Cargo.toml
index d2c58f5..97d19d9 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,10 +1,13 @@
[package]
name = "bk"
-version = "0.1.0"
+version = "0.1.1"
authors = ["James Campos <james.r.campos@gmail.com>"]
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]
diff --git a/README.md b/README.md
index af0ef2d..d762f07 100644
--- a/README.md
+++ b/README.md
@@ -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