aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorbenadha <benawiadha@gmail.com>2020-11-19 22:18:25 +0700
committerbenadha <benawiadha@gmail.com>2020-11-19 22:18:25 +0700
commit8f1113c2d2ec193561a49704c4a07a41ec2bc8cb (patch)
tree4d86f2312985f27d94255f7edce2503622c464ba /README.md
parentd27f0d3f312ac6d63f0aae7a1a18d6ca0c9523fc (diff)
downloadepy-8f1113c2d2ec193561a49704c4a07a41ec2bc8cb.tar.gz
PyPI compliant
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index 0694e7b..009854d 100644
--- a/README.md
+++ b/README.md
@@ -17,6 +17,20 @@ This is just a fork of my own [epr](https://github.com/wustho/epr) with these ex
# Installation
+## Via PyPI
+
+```shell
+$ pip3 install epy-reader
+```
+
+## Via Pip+Git
+
```shell
$ pip3 install git+https://github.com/wustho/epy
```
+
+# Reading Tips Using Epy
+
+When reading using `epy` you might occasionally find triple asteriks `***`.
+That means you reach the end of some section in your ebook and the next line (right after those three asteriks, which is in new section) will start at the top of the page.
+This might be disorienting, so the best way to get seamless reading experience is by using next-page control (`space`, `l` or `Right`) instead of next-line control (`j` or `Down`).