From f226006062fcbc7fdfeb4a07816bb6364cbae317 Mon Sep 17 00:00:00 2001 From: TheOnlyWayUp <76237496+TheOnlyWayUp@users.noreply.github.com> Date: Sat, 30 Dec 2023 19:10:19 +0530 Subject: [PATCH] Update README.md --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7d46288..74f50d8 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,31 @@ WattpadDownloader --- Straightforward, Extendable WebApp to download Wattpad Books as EPUB Files. -Stars ⭐ are appreciated. Thanks +![image](https://github.com/TheOnlyWayUp/WattpadDownloader/assets/76237496/8a3fda0b-b851-4c5f-9306-ba9c17cdcc8b) + + +Stars ⭐ are appreciated. Thanks! + +## Features +- ⚡ Lightweight Frontend and Minimal Javascript. +- 🌐 API Support (Visit the `/docs` path on your instance for more.) +- 🐇 Fast Generation, Basic Ratelimit Handling. +- 🐳 Docker Support +- 🏷️ Generated EPUB File includes Metadata. (Dublin Core Spec) +- 📖 Plays well with E-Readers. (Kindle Support if KOReader present) +- 💻 Easily Hackable. Extend with ease. + + +## Set Up +1. Clone the repository: `git clone https://github.com/TheOnlyWayUp/WattpadDownloader/ && cd WattpadDownloader` +2. Build the image: `docker build . -t 'wp_downloader'` (This takes about 2 Minutes) +3. Run the Container: `docker run -d -p 5042:80 wp_downloader` + +That's it! You can use your instance at `http://localhost:5042`. API Documentation is available at `http://localhost:5042/docs`. + +--- + +My thanks to [aerkalov/ebooklib](https://github.com/aerkalov/ebooklib) for a fast and well-documented package. ---