Update README.md

Added some extra information and cleaned up goals.
This commit is contained in:
Joseph Milazzo 2021-02-15 10:11:54 -06:00 committed by GitHub
parent 5ee27b5e7b
commit 3a8ec47e75
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -3,14 +3,14 @@ Kavita, meaning Stories, is a lightweight manga server. The goal is to replace U
open source variant that is flexible and packs more punch, without sacrificing ease to use.
## Goals:
* Server up Comics (cbr, cbz, zip/rar, pdf, raw images) and Books (epub, mobi, azw, djvu, pdf)
* Provide Reader for Comics and Books via web app that is responsive
* Serve up Manga (cbr, cbz, zip/rar, raw images) and Books (epub, mobi, azw, djvu, pdf)
* Provide Reader for Manga and Books (Light Novels) via web app that is responsive
* Provide customization themes (server installed) for web app
* Provide hooks into metadata providers to fetch Manga/Comic data
* Provide hooks into metadata providers to fetch Manga data
* Metadata should allow for collections, want to read integration from 3rd party services, genres.
* Ability to manage users, access, and ratings
* Expose an OPDS API/Stream for external readers to use
* Allow downloading files directly from WebApp
* WebApp/Server is Translated via Weblate (free for Open Source)
## How to Deploy