From 2a96c8d61a267022a15f8c7113ccc960efc2706d Mon Sep 17 00:00:00 2001
From: t510599 <t510599@gmail.com>
Date: Fri, 26 Jun 2020 22:43:06 +0800
Subject: [PATCH] Add README.md

---
 README.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3aab618
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+# epub_convert
+Online Version: https://epub.stoneapp.tech/
+
+## Requirements
+- Python 3.6 or newer
+
+## Libraries
+- Flask >= 0.13.0
+- OpenCC
+- TocasUI
+- axios
+
+## Usage
+- command line
+```bash
+$ python convert.py <epub>
+```
+
+- development web server
+```bash
+$ python web.py
+```
+
+- apache `mod_wsgi`
+```apache
+<VirtualHost *:80>
+    ServerName domain.name
+
+    WSGIDaemonProcess appname user=user1 group=group1 threads=5
+    WSGIScriptAlias / /location/to/folder/web.wsgi
+    Alias /static /location/to/folder/static
+
+    <Directory "/location/to/folder">
+        Require all granted
+    </Directory>
+</VirtualHost>
+```
\ No newline at end of file