diff --git a/README.md b/README.md index 9802ee5..a92f26c 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ It shall NOT be edited by hand. # Flood for YunoHost -[![Integration level](https://dash.yunohost.org/integration/flood.svg)](https://dash.yunohost.org/appci/app/flood) ![](https://ci-apps.yunohost.org/ci/badges/flood.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/flood.maintain.svg) +[![Integration level](https://dash.yunohost.org/integration/flood.svg)](https://dash.yunohost.org/appci/app/flood) ![Working status](https://ci-apps.yunohost.org/ci/badges/flood.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/flood.maintain.svg) [![Install Flood with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=flood) *[Lire ce readme en français.](./README_fr.md)* @@ -15,33 +15,32 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in ## Overview -Client torrent. +Flood is a monitoring service for various torrent clients. It's a Node.js service that communicates with your favorite torrent client and serves a decent web UI for administration. **Shipped version:** 4.7.0~ynh2 - - ## Screenshots -![](./doc/screenshots/screenshot.png) +![Screenshot of Flood](./doc/screenshots/screenshot.png) ## Documentation and resources -* Official app website: https://github.com/jesec/flood -* Official admin documentation: https://github.com/jesec/flood/wiki -* Upstream app code repository: https://github.com/jesec/flood -* YunoHost documentation for this app: https://yunohost.org/app_flood -* Report a bug: https://github.com/YunoHost-Apps/flood_ynh/issues +* Official app website: +* Official admin documentation: +* Upstream app code repository: +* YunoHost documentation for this app: +* Report a bug: ## Developer info Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/flood_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/flood_ynh/tree/testing --debug or sudo yunohost app upgrade flood -u https://github.com/YunoHost-Apps/flood_ynh/tree/testing --debug ``` -**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index 8e9441c..ffb7b6c 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,43 +1,46 @@ + + # Flood pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/flood.svg)](https://dash.yunohost.org/appci/app/flood) ![](https://ci-apps.yunohost.org/ci/badges/flood.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/flood.maintain.svg) +[![Niveau d'intégration](https://dash.yunohost.org/integration/flood.svg)](https://dash.yunohost.org/appci/app/flood) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/flood.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/flood.maintain.svg) [![Installer Flood avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=flood) *[Read this readme in english.](./README.md)* -*[Lire ce readme en français.](./README_fr.md)* > *Ce package vous permet d'installer Flood 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 -Torrent client. +Flood is a monitoring service for various torrent clients. It's a Node.js service that communicates with your favorite torrent client and serves a decent web UI for administration. **Version incluse :** 4.7.0~ynh2 - - ## Captures d'écran -![](./doc/screenshots/screenshot.png) +![Capture d'écran de Flood](./doc/screenshots/screenshot.png) ## Documentations et ressources -* Site officiel de l'app : https://github.com/jesec/flood -* Documentation officielle de l'admin : https://github.com/jesec/flood/wiki -* Dépôt de code officiel de l'app : https://github.com/jesec/flood -* Documentation YunoHost pour cette app : https://yunohost.org/app_flood -* Signaler un bug : https://github.com/YunoHost-Apps/flood_ynh/issues +* Site officiel de l'app : +* Documentation officielle de l'admin : +* Dépôt de code officiel de l'app : +* Documentation YunoHost pour cette app : +* Signaler un bug : ## Informations pour les développeurs Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/flood_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/flood_ynh/tree/testing --debug ou sudo yunohost app upgrade flood -u https://github.com/YunoHost-Apps/flood_ynh/tree/testing --debug ``` -**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file +**Plus d'infos sur le packaging d'applications :**