diff --git a/README.md b/README.md index 5d8e226..f6f4b45 100644 --- a/README.md +++ b/README.md @@ -1,59 +1,40 @@ + + # CouchPotato for YunoHost [![Integration level](https://dash.yunohost.org/integration/couchpotato.svg)](https://dash.yunohost.org/appci/app/couchpotato) ![](https://ci-apps.yunohost.org/ci/badges/couchpotato.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/couchpotato.maintain.svg) -[![Install CouchPotato with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=couchpotato) +[![Install CouchPotato with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=couchpotato) -> *This package allows you to install CouchPotato quickly and simply on a YunoHost server. +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install CouchPotato 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 -Download movies automatically, easily and in the best quality as soon as they are available. -- Integrates automatically with [transmission_ynh](https://github.com/YunoHost-Apps/transmission_ynh) (or tries to...), -- Integrates [YunoHost multimedia](https://github.com/YunoHost-Apps/yunohost.multimedia) folder structure +Automatic movie downloader -**Shipped version:** 3.0.1 +**Shipped version:** 3.0.1~ynh3 -## YunoHost specific features -#### Supported architectures -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/couchpotato%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/couchpotato/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/couchpotato%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/couchpotato/) +## Disclaimers / important information -## Links +* Other infos that people should be aware of, such as: + * Integrates automatically with [transmission_ynh](https://github.com/YunoHost-Apps/transmission_ynh) (or tries to...), + * Integrates [YunoHost multimedia](https://github.com/YunoHost-Apps/yunohost.multimedia) folder structure - * Report a bug: https://github.com/YunoHost-Apps/couchpotato_ynh/issues - * App website: https://couchpota.to - * Upstream app repository: https://github.com/CouchPotato/CouchPotatoServer - * YunoHost website: https://yunohost.org/ +## Documentation and resources -#### Special Thanks to the Yunohost Community: -[Snipees](https://github.com/Snipees) -[anaqreon](https://github.com/anaqreon), -[aymhce](https://github.com/aymhce), -[beudbeud](https://github.com/abeudin), -[Chao-Man](https://github.com/Chao-Man), -[chtixof](https://github.com/chtixof), -[CotzaDev](https://github.com/CotzaDev), -[courgette](https://github.com/courgette), -[Jérôme](https://github.com/jeromelebleu), -[JocelynD](https://github.com/JocelynDelalande), -[Ju](https://github.com/julienmalik), -[Le Kload](https://github.com/Kloadut), -[lunarok](https://github.com/lunarok), -[maniackcrudelis](https://github.com/maniackcrudelis), -[Matlink](https://github.com/matlink), -[Moul](https://github.com/M5oul), -[polytan02](https://github.com/polytan02), -[scith](https://github.com/scith), -[tifred](https://github.com/drfred1981), -... :dizzy: +* Official app website: https://couchpota.to +* Upstream app code repository: https://github.com/CouchPotato/CouchPotatoServer +* YunoHost documentation for this app: https://yunohost.org/app_couchpotato +* Report a bug: https://github.com/YunoHost-Apps/couchpotato_ynh/issues ---- - -Developer info ----------------- +## Developer info Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/couchpotato_ynh/tree/testing). @@ -63,3 +44,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/couchpotato_ynh/tree/ or sudo yunohost app upgrade couchpotato -u https://github.com/YunoHost-Apps/couchpotato_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..c7ddab4 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,44 @@ +# CouchPotato pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/couchpotato.svg)](https://dash.yunohost.org/appci/app/couchpotato) ![](https://ci-apps.yunohost.org/ci/badges/couchpotato.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/couchpotato.maintain.svg) +[![Installer CouchPotato avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=couchpotato) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer CouchPotato rapidement et simplement sur un serveur YunoHost. +Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* + +## Vue d'ensemble + +Téléchargement automatisé de film + +**Version incluse :** 3.0.1~ynh3 + + + +## Avertissements / informations importantes + +* Other infos that people should be aware of, such as: + * Integrates automatically with [transmission_ynh](https://github.com/YunoHost-Apps/transmission_ynh) (or tries to...), + * Integrates [YunoHost multimedia](https://github.com/YunoHost-Apps/yunohost.multimedia) folder structure + +## Documentations et ressources + +* Site officiel de l'app : https://couchpota.to +* Dépôt de code officiel de l'app : https://github.com/CouchPotato/CouchPotatoServer +* Documentation YunoHost pour cette app : https://yunohost.org/app_couchpotato +* Signaler un bug : https://github.com/YunoHost-Apps/couchpotato_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/couchpotato_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/couchpotato_ynh/tree/testing --debug +ou +sudo yunohost app upgrade couchpotato -u https://github.com/YunoHost-Apps/couchpotato_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file