feat: add Docker support, and documentation for it

2023-11-30 22:28:50 -05:00
parent 0a2a8d3992
commit 5dccfbeeec
3 changed files with 45 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,17 @@
+# send2ereader
+
+A self hostable service for sending ebooks to a Kobo or Kindle ereader through the built-in browser.
+
+## How To Run
+
+### On Your Host OS
+
+1. Have Node 16 installed
+2. Install this service's dependencies by running `$ npm install`
+3. Install [Kepubify](https://github.com/pgaskin/kepubify), and have the executable in your path.
+4. Start this service by running: `$ node index`
+
+### Containerized
+
+1. Have Docker installed
+2. Run `$ docker compose up`