aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFuwn <[email protected]>2023-07-21 17:56:36 -0700
committerGitHub <[email protected]>2023-07-21 17:56:36 -0700
commit68df753019d7502a4b5f791f1f08331e1847fd77 (patch)
tree6ea7d9e384f1991bb42bb26e4f6ab66645329962
parentfeat: initial release (diff)
downloadhayai-68df753019d7502a4b5f791f1f08331e1847fd77.tar.xz
hayai-68df753019d7502a4b5f791f1f08331e1847fd77.zip
doc(readme): add disclaimerv0.1.0
-rw-r--r--README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/README.md b/README.md
index 7b232b5..265df21 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,11 @@
> Upload an EPUB, receive a **"bi**onic" **EP**UB.
+The "bionic" functionality is implemented using [brec](https://github.com/dobrosketchkun/bionic-reading-epub-converter).
+If you need a command-line "bionic" converter, use brec. If you don't always have access to a command-line, use hayai.
+
+This project was scrapped together in under ten minutes, but it should be pretty safe.
+
---
This project is licensed with the [GNU General Public License v3.0](https://github.com/Fuwn/hayai/blob/main/LICENSE).