From c167d4662ba719b443b506989f48f78a9fa4dee7 Mon Sep 17 00:00:00 2001 From: daniel-j Date: Tue, 5 Dec 2023 21:06:12 +0100 Subject: [PATCH] update readme --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ca0d58c..27377a3 100644 --- a/README.md +++ b/README.md @@ -6,12 +6,14 @@ A self hostable service for sending ebooks to a Kobo or Kindle ereader through t ### On Your Host OS -1. Have Node 16 installed +1. Have Node.js 16 or 20 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` +3. Install [Kepubify](https://github.com/pgaskin/kepubify), and have the kepubify executable in your PATH. +4. Install [KindleGen](https://archive.org/details/kindlegen2.9), and have the kindlegen executable in your PATH. +5. Start this service by running: `$ npm start` and access it on HTTP port 3001 ### Containerized 1. Have Docker installed 2. Run `$ docker compose up` +3. Access the service on HTTP port 3001