cops_ynh/README.md

<!--
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
It shall NOT be edited by hand.
-->

# COPS for YunoHost

[![Integration level](https://dash.yunohost.org/integration/cops.svg)](https://dash.yunohost.org/appci/app/cops) ![Working status](https://ci-apps.yunohost.org/ci/badges/cops.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/cops.maintain.svg)

[![Install COPS with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=cops)

*[Read this README in other languages.](./ALL_README.md)*

> *This package allows you to install COPS 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

Creates an OPDS and HTML server based on a Calibre folder stored in NextCloud


**Shipped version:** 1.1.3~ynh2

**Demo:** <http://cops-demo.slucas.fr/index.php>
## :red_circle: Antifeatures

- **Package not maintained**: This YunoHost package is not actively maintained and needs adoption. This means that minimal maintenance is made by volunteers who don't use the app, so you should expect the app to lose reliability over time. You can [learn how to package](https://yunohost.org/packaging_apps_intro) if you'd like to adopt it.

## Documentation and resources

- Official app website: <https://blog.slucas.fr/projects/calibre-opds-php-server/>
- Upstream app code repository: <https://github.com/seblucas/cops>
- YunoHost Store: <https://apps.yunohost.org/app/cops>
- Report a bug: <https://github.com/YunoHost-Apps/cops_ynh/issues>

## Developer info

Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/cops_ynh/tree/testing).

To try the `testing` branch, please proceed like that:

```bash
sudo yunohost app install https://github.com/YunoHost-Apps/cops_ynh/tree/testing --debug
or
sudo yunohost app upgrade cops -u https://github.com/YunoHost-Apps/cops_ynh/tree/testing --debug
```

**More info regarding app packaging:** <https://yunohost.org/packaging_apps>