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

README.md

@@ -1,23 +1,55 @@
-# pyLoad app for YunoHost
+<!--
-pyLoad
+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)
+# pyLoad for YunoHost
-- [pyLoad website](https://pyload.net/)
 
-![](https://pyload.net/img/banner.png)
+[![Integration level](https://dash.yunohost.org/integration/pyload.svg)](https://dash.yunohost.org/appci/app/pyload) ![](https://ci-apps.yunohost.org/ci/badges/pyload.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/pyload.maintain.svg)  
+[![Install pyLoad with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pyload)
+
+*[Lire ce readme en français.](./README_fr.md)*
+
+> *This package allows you to install pyLoad 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
+
+The free and open-source Download Manager written in pure Python
 
 
-[![Install pyLoad with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=pyload)
+**Shipped version:** 0.4.20~ynh1
 
-### Installing guide
 
- 1. App can be installed by YunoHost **admin web-interface** or by **running following command**:
 
-         $ sudo yunohost app install https://github.com/YunoHost-Apps/pyload_ynh
+## Screenshots
- 1. Admin username is : **root**.
 
- 
+![](./doc/screenshots/sample.png)
-### Upgrade this package:
 
-        $ sudo yunohost app upgrade --verbose example -u https://github.com/YunoHost-Apps/pyload_ynh
+## Disclaimers / important information
 
+-   Default username: `pyload`.
+-   Default password: `pyload`.
+
+**It's highly recommended to change the default access credentials on first start**.
+
+## Documentation and resources
+
+* Official app website: https://pyload.net
+* Official admin documentation: https://github.com/pyload/pyload/wiki
+* Upstream app code repository: https://github.com/pyload/pyload
+* YunoHost documentation for this app: https://yunohost.org/app_pyload
+* Report a bug: https://github.com/YunoHost-Apps/pyload_ynh/issues
+
+## Developer info
+
+Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/pyload_ynh/tree/testing).
+
+To try the testing branch, please proceed like that.
+```
+sudo yunohost app install https://github.com/YunoHost-Apps/pyload_ynh/tree/testing --debug
+or
+sudo yunohost app upgrade pyload -u https://github.com/YunoHost-Apps/pyload_ynh/tree/testing --debug
+```
+
+**More info regarding app packaging:** https://yunohost.org/packaging_apps

README_fr.md

@@ -0,0 +1,51 @@
+# pyLoad pour YunoHost
+
+[![Niveau d'intégration](https://dash.yunohost.org/integration/pyload.svg)](https://dash.yunohost.org/appci/app/pyload) ![](https://ci-apps.yunohost.org/ci/badges/pyload.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/pyload.maintain.svg)  
+[![Installer pyLoad avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pyload)
+
+*[Read this readme in english.](./README.md)*
+*[Lire ce readme en français.](./README_fr.md)*
+
+> *Ce package vous permet d'installer pyLoad 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
+
+The free and open-source Download Manager written in pure Python
+
+
+**Version incluse :** 0.4.20~ynh1
+
+
+
+## Captures d'écran
+
+![](./doc/screenshots/sample.png)
+
+## Avertissements / informations importantes
+
+-   Default username: `pyload`.
+-   Default password: `pyload`.
+
+**It's highly recommended to change the default access credentials on first start**.
+
+## Documentations et ressources
+
+* Site officiel de l'app : https://pyload.net
+* Documentation officielle de l'admin : https://github.com/pyload/pyload/wiki
+* Dépôt de code officiel de l'app : https://github.com/pyload/pyload
+* Documentation YunoHost pour cette app : https://yunohost.org/app_pyload
+* Signaler un bug : https://github.com/YunoHost-Apps/pyload_ynh/issues
+
+## Informations pour les développeurs
+
+Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/pyload_ynh/tree/testing).
+
+Pour essayer la branche testing, procédez comme suit.
+```
+sudo yunohost app install https://github.com/YunoHost-Apps/pyload_ynh/tree/testing --debug
+ou
+sudo yunohost app upgrade pyload -u https://github.com/YunoHost-Apps/pyload_ynh/tree/testing --debug
+```
+
+**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps