From 3a8ec47e75468525933906ca394cd31a3887d2ee Mon Sep 17 00:00:00 2001 From: Joseph Milazzo Date: Mon, 15 Feb 2021 10:11:54 -0600 Subject: [PATCH] Update README.md Added some extra information and cleaned up goals. --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 78693433b..20aca8a85 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,18 @@ # Kavita Kavita, meaning Stories, is a lightweight manga server. The goal is to replace Ubooqity with an -open source variant that is flexible and packs more punch, without sacrificing ease to use. +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 * Build kavita-webui via ng build --prod. The dest should be placed in the API/wwwroot directory -* Run publish command \ No newline at end of file +* Run publish command