Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Added some extra information and cleaned up goals.
  • Loading branch information
majora2007 authored Feb 15, 2021
1 parent 5ee27b5 commit 3a8ec47
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
* Run publish command

0 comments on commit 3a8ec47

Please sign in to comment.