aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJames Campos <james.r.campos@gmail.com>2020-05-17 02:04:25 -0700
committerJames Campos <james.r.campos@gmail.com>2020-05-17 02:04:25 -0700
commit6100ffbfab86081fa1e9e033717c54b0edc99d08 (patch)
treeeb8d47e8d934f5fb575386377e9af0a552d6fc67 /README.md
parentd7ce4bdadb10ea4e70f8e48e2ddb990cf3087c49 (diff)
downloadbk-6100ffbfab86081fa1e9e033717c54b0edc99d08.tar.gz
readme, fmt
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 6 insertions, 3 deletions
diff --git a/README.md b/README.md
index aefe1ee..bc04df8 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
# bk
-bk is a terminal Epub reader. Currently only Linux is tested, but macOS and Windows support is planned.
+bk is a WIP terminal Epub reader, written in Rust.
+
+bk supports Linux and macOS. Windows runs but doesn't save position on exit.
# Usage
@@ -17,14 +19,15 @@ Running `bk` without an argument will load the most recent Epub.
- Vim bindings
# TODO
-- macOS, Windows
+- fix Windows
- configuration
- links
- better unicode support
- better html rendering
- mobi?
+- images?
- css?
- gui?
-# inspiration
+# Inspiration
<https://github.com/wustho/epr>