summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAndrew Dolgov <[email protected]>2017-02-26 15:41:51 +0300
committerAndrew Dolgov <[email protected]>2017-02-26 15:41:51 +0300
commiteff1488c56a209c993b5ecf3a43efb9d8c52a2bb (patch)
treeeb52d6c3a15340b7a705eb4d7d271985ad57a4d4 /README.md
parentf236b1f9a7b3a984fd539013ba32d93a90e17c2d (diff)
upd readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 10 insertions, 4 deletions
diff --git a/README.md b/README.md
index a578741..2b7885f 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,19 @@
The Epube
=========
-responsive web EPUB reader using EPUB.js and Calibre database
+web EPUB reader using EPUB.js, Bootstrap, and Calibre.
-relies on HTTP Authentication provided by httpd
-has transparent offline mode via service workers
+* responsive design
+* relies on HTTP Authentication provided by httpd
+* has transparent offline mode via service workers
+* can optionally store files locally for later reading
+* supports Chrome homescreen "app mode"
-due to EPUB.js strangeness, some URL rewriting is required (nginx config included)
+Requirements
+============
+* php-sqlite
+* Calibre books directory and metadata.db
Acknowledgements
================