YunoHost-Apps/komga_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/komga_ynh.git synced 2024-09-03 19:36:07 +02:00
Code Issues Activity Actions

updated README

Browse source
This commit is contained in:
Navan Chauhan 2021-02-28 16:01:18 +05:30
parent fe68182d01
commit a91b7aee10
1 changed files with 24 additions and 33 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

57
README.md
View file

@ -1,50 +1,49 @@
# Usage of this package (REMOVE THIS SECTION BEFORE RELEASE) # Komga
- 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`.
# Example app for YunoHost [![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)
[![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)
*[Lire ce readme en français.](./README_fr.md)* *[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.* If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview ## 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 ## Screenshots
![](Link to a screenshot of this app.) ![](./screenshots/home.png)
## Demo ## Demo
* [Official demo](Link to a demo site for this app.) * [Official demo](https://demo.komga.org)
## Configuration ## 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 ## Documentation
* Official documentation: Link to the official documentation of this app * Official documentation: Link to the official documentation of this app
* YunoHost documentation: If specific documentation is needed, feel free to contribute.
## YunoHost specific features ## YunoHost specific features
#### Multi-user support #### Multi-user support
Are LDAP and HTTP auth supported? Are LDAP and HTTP auth supported? **No**
Can the app be used by multiple users? Can the app be used by multiple users? **Yes**
#### Supported architectures #### Supported architectures
@ -53,18 +52,11 @@ Can the app be used by multiple users?
## Limitations ## Limitations
* Any known limitations. * None discovered yet.
## Additional information
* Other info you would like to add about this app.
**More info on the documentation page:**
https://yunohost.org/packaging_apps
## Links ## 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. * App website: Link to the official website of this app.
* Upstream app repository: Link to the official repository of the upstream app. * Upstream app repository: Link to the official repository of the upstream app.
* YunoHost website: https://yunohost.org/ * YunoHost website: https://yunohost.org/
@ -73,12 +65,11 @@ https://yunohost.org/packaging_apps
## Developer info ## 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/komga_ynh/tree/testing).
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing).
To try the testing branch, please proceed like that. To try the testing branch, please proceed like that.
``` ```
sudo yunohost app install https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug
or 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
``` ```