StefanMewes/send2ereader
1
0
Fork 0
Code Pull Requests Actions Packages Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
daniel-j
2023-12-05 21:06:12 +01:00
parent 366282b460
commit c167d4662b
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -6,12 +6,14 @@ A self hostable service for sending ebooks to a Kobo or Kindle ereader through t
### On Your Host OS ### 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` 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. 3. Install [Kepubify](https://github.com/pgaskin/kepubify), and have the kepubify executable in your PATH.
4. Start this service by running: `$ node index` 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 ### Containerized
1. Have Docker installed 1. Have Docker installed
2. Run `$ docker compose up` 2. Run `$ docker compose up`
3. Access the service on HTTP port 3001