Merge branch 'example' of https://github.com/YunoHost-Apps/flood_ynh into example

README.md

@@ -1,22 +1,43 @@
-# Example app for YunoHost
+<!--
+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.
+-->
 
-- [Yunohost project](https://yunohost.org)
+# Flood for YunoHost
-- [Exemple app website](https://example.com)
 
-Description of the app.
+[![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)  
+[![Install Flood with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=flood)
 
-## Usage
+*[Lire ce readme en français.](./README_fr.md)*
-- Copy this app before work on it.
-- Edit `conf/nginx.conf` file to match application prerequisites.
-- Edit `manifest.json` with application specific information.
-- Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts.
-- Add a `LICENSE` file for the package.
-- Edit `README.md`.
 
-**More information on the documentation page:**    
+> *This package allows you to install Flood quickly and simply on a YunoHost server.
-https://yunohost.org/packaging_apps
+If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
 
-**Upgrade this package:**  
+## Overview
-`sudo yunohost app upgrade --verbose example -u https://github.com/YunoHost-Apps/example_ynh`
 
-**Multi-user:** Yes/No. How about the ldap and HTTP auth support.
+Client torrent.
+
+**Shipped version:** 4.7.0~ynh1
+
+
+
+## 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
+
+## 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.
+```
+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

README_fr.md

@@ -0,0 +1,39 @@
+# 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)  
+[![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.
+
+**Version incluse :** 4.7.0~ynh1
+
+
+
+## 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
+
+## 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.
+```
+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