Auto-update README

README.md

@@ -1,15 +1,31 @@
+<!--
+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.
+-->
+
 # Plume for YunoHost
 
 [![Integration level](https://dash.yunohost.org/integration/plume.svg)](https://dash.yunohost.org/appci/app/plume) ![](https://ci-apps.yunohost.org/ci/badges/plume.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/plume.maintain.svg)  
 [![Install Plume with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=plume)
 
-> *This package allows you to install Plume quickly and simply on a YunoHost server.  
+*[Lire ce readme en français.](./README_fr.md)*
+
+> *This package allows you to install Plume 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
+
 Federated blogging engine, based on ActivityPub. It uses the Rocket framework, and Diesel to interact with the database. 
 
-**Shipped version:** 0.6.0
+**Shipped version:** 0.6.0~ynh2
+
+**Demo:** https://joinplu.me/#instances
+
+## Screenshots
+
+![](./doc/screenshots/screenshot.png)
+
+## Disclaimers / important information
 
 **Warning:** The package can take **15 to 30 minutes** to complete depending on your system configuration. **Don't intrupt the installation process while installing.**
 
@@ -19,41 +35,16 @@ Federated blogging engine, based on ActivityPub. It uses the Rocket framework, a
 1. **Plume** require a valid **certificate** installed on the domain. Yunohost can **install Letsencrypt certificate** on the domain from **admin web-interface** or through **command-line**.
 1. This package is **multi-instance** that means you can run **multiple Plume instances** on a **single server**.
 
-## Screenshots
-
-![plume-screenshot1](https://user-images.githubusercontent.com/30271971/52232065-d6d83600-28bb-11e9-9a0a-b4b139c2eb25.png)
-
-## Demo
-
-* [List of instances](https://joinplu.me/#instances)
-
-## Documentation
-
- * Official documentation: https://docs.joinplu.me/
-
-## YunoHost specific features
-
 #### Multi-user support
 
 LDAP is activated but HTTP auth is not supported
+## Documentation and resources
 
-#### Supported architectures
+* Official app website: https://joinplu.me/
-
+* Official admin documentation: https://docs.joinplu.me/
-* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/plume.svg)](https://ci-apps.yunohost.org/ci/apps/plume/)
+* Upstream app code repository: https://github.com/Plume-org/Plume
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/plume.svg)](https://ci-apps-arm.yunohost.org/ci/apps/plume/)
+* YunoHost documentation for this app: https://yunohost.org/app_plume
-
+* Report a bug: https://github.com/YunoHost-Apps/plume_ynh/issues
-## Limitations
-
-* No known limitations.
-
-## Links
-
- * Report a bug: https://github.com/YunoHost-Apps/plume_ynh/issues
- * App website: https://joinplu.me/
- * Upstream app repository: https://github.com/Plume-org/Plume
- * YunoHost website: https://yunohost.org/
-
----
 
 ## Developer info
 
@@ -65,3 +56,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/plume_ynh/tree/testin
 or
 sudo yunohost app upgrade plume -u https://github.com/YunoHost-Apps/plume_ynh/tree/testing --debug
 ```
+
+**More info regarding app packaging:** https://yunohost.org/packaging_apps

README_fr.md

@@ -0,0 +1,56 @@
+# Plume pour YunoHost
+
+[![Niveau d'intégration](https://dash.yunohost.org/integration/plume.svg)](https://dash.yunohost.org/appci/app/plume) ![](https://ci-apps.yunohost.org/ci/badges/plume.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/plume.maintain.svg)  
+[![Installer Plume avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=plume)
+
+*[Read this readme in english.](./README.md)*
+*[Lire ce readme en français.](./README_fr.md)*
+
+> *Ce package vous permet d'installer Plume 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
+
+Federated blogging engine, based on ActivityPub. It uses the Rocket framework, and Diesel to interact with the database. 
+
+**Version incluse :** 0.6.0~ynh2
+
+**Démo :** https://joinplu.me/#instances
+
+## Captures d'écran
+
+![](./doc/screenshots/screenshot.png)
+
+## Avertissements / informations importantes
+
+**Warning:** The package can take **15 to 30 minutes** to complete depending on your system configuration. **Don't intrupt the installation process while installing.**
+
+## Important points to read before installing
+1. **Plume** is still in **pre-release** stage and undergoing heavy development, so there can be **bugs**.
+1. **Plume** require a dedicated **root domain**, eg. plume.domain.tld
+1. **Plume** require a valid **certificate** installed on the domain. Yunohost can **install Letsencrypt certificate** on the domain from **admin web-interface** or through **command-line**.
+1. This package is **multi-instance** that means you can run **multiple Plume instances** on a **single server**.
+
+#### Multi-user support
+
+LDAP is activated but HTTP auth is not supported
+## Documentations et ressources
+
+* Site officiel de l'app : https://joinplu.me/
+* Documentation officielle de l'admin : https://docs.joinplu.me/
+* Dépôt de code officiel de l'app : https://github.com/Plume-org/Plume
+* Documentation YunoHost pour cette app : https://yunohost.org/app_plume
+* Signaler un bug : https://github.com/YunoHost-Apps/plume_ynh/issues
+
+## Informations pour les développeurs
+
+Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/plume_ynh/tree/testing).
+
+Pour essayer la branche testing, procédez comme suit.
+```
+sudo yunohost app install https://github.com/YunoHost-Apps/plume_ynh/tree/testing --debug
+ou
+sudo yunohost app upgrade plume -u https://github.com/YunoHost-Apps/plume_ynh/tree/testing --debug
+```
+
+**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps