From a91b7aee10ed4a05d8904cf24668d2548c32d2dc Mon Sep 17 00:00:00 2001 From: Navan Chauhan Date: Sun, 28 Feb 2021 16:01:18 +0530 Subject: [PATCH] updated README --- README.md | 57 +++++++++++++++++++++++-------------------------------- 1 file changed, 24 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index fb6c89c..e4ca567 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,49 @@ -# Usage of this package (REMOVE THIS SECTION BEFORE RELEASE) -- Copy this app before working on it. -- Edit the `conf/nginx.conf` file to match app prerequisites. -- Edit the `manifest.json` with app specific info. -- Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts. - - Using the [script helpers documentation.](https://yunohost.org/#/packaging_apps_helpers) -- Add a `LICENSE` file for the package. -- Edit `README.md` and `README_fr.md`. +# Komga -# Example app for YunoHost - -[![Integration level](https://dash.yunohost.org/integration/REPLACEBYYOURAPP.svg)](https://dash.yunohost.org/appci/app/REPLACEBYYOURAPP) ![](https://ci-apps.yunohost.org/ci/badges/REPLACEBYYOURAPP.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/REPLACEBYYOURAPP.maintain.svg) -[![Install REPLACEBYYOURAPP with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=REPLACEBYYOURAPP) +[![Integration level](https://dash.yunohost.org/integration/Komga.svg)](https://dash.yunohost.org/appci/app/Komga) ![](https://ci-apps.yunohost.org/ci/badges/Komga.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/Komga.maintain.svg) +[![Install Komga with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=komga) *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install REPLACEBYYOURAPP quickly and simply on a YunoHost server. +> *This package allows you to install Komga quickly and simply on a YunoHost server. If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* ## Overview -Quick description of this app. -**Shipped version:** 1.0 +Komga is a free and open source comics/mangas server. + +Features include: + +* Browse libraries, series and books +* Search bar +* Download book files +* Manage multiple users, with per-library accesss control +* Webreader + +**Shipped version:** 0.75.2 ## Screenshots -![](Link to a screenshot of this app.) +![](./screenshots/home.png) ## Demo -* [Official demo](Link to a demo site for this app.) +* [Official demo](https://demo.komga.org) ## Configuration -How to configure this app: From an admin panel, a plain file with SSH, or any other way. +For most configurations, you can use the Admin panel in Komga. ## Documentation * Official documentation: Link to the official documentation of this app - * YunoHost documentation: If specific documentation is needed, feel free to contribute. ## YunoHost specific features #### Multi-user support -Are LDAP and HTTP auth supported? -Can the app be used by multiple users? +Are LDAP and HTTP auth supported? **No** +Can the app be used by multiple users? **Yes** #### Supported architectures @@ -53,18 +52,11 @@ Can the app be used by multiple users? ## Limitations -* Any known limitations. - -## Additional information - -* Other info you would like to add about this app. - -**More info on the documentation page:** -https://yunohost.org/packaging_apps +* None discovered yet. ## Links - * Report a bug: https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/issues + * Report a bug: https://github.com/YunoHost-Apps/komga_ynh/issues * App website: Link to the official website of this app. * Upstream app repository: Link to the official repository of the upstream app. * YunoHost website: https://yunohost.org/ @@ -73,12 +65,11 @@ https://yunohost.org/packaging_apps ## Developer info -**Only if you want to use a testing branch for coding, instead of merging directly into master.** -Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/komga_ynh/tree/testing). To try the testing branch, please proceed like that. ``` sudo yunohost app install https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug or -sudo yunohost app upgrade REPLACEBYYOURAPP -u https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug +sudo yunohost app upgrade REPLACEBYYOURAPP -u https://github.com/YunoHost-Apps/komga_ynh/tree/testing --debug ```