From 6af992af17d3e4b28e4c55c069a2ac9deaacd11b Mon Sep 17 00:00:00 2001
From: OniriCorpe <oniricorpe@disroot.org>
Date: Mon, 6 Jun 2022 19:45:13 +0200
Subject: [PATCH 1/3] readme update

---
 README.md    | 62 ++++++++++++++++++++++++++--------------------------
 README_fr.md | 55 ++++++++++++++++++++++++++--------------------
 2 files changed, 62 insertions(+), 55 deletions(-)

diff --git a/README.md b/README.md
index 820e437..ad5c05b 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,14 @@
+# Packaging your an app, starting from this example
 
-# Packaging an app, starting from this example
-
-- Copy this app before working on it, using the ['Use this template'](https://github.com/YunoHost/example_ynh/generate) button on the Github repo.
-- Edit the `manifest.json` with app specific info.
-- Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts, and any relevant conf files in `conf/`.
-  - Using the [script helpers documentation.](https://yunohost.org/packaging_apps_helpers)
-- Add a `LICENSE` file for the package.
-- Edit `doc/DISCLAIMER*.md`
-- The `README.md` files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
-
+* Copy this app before working on it, using the ['Use this template'](https://github.com/YunoHost/example_ynh/generate) button on the Github repo.
+* Edit the `manifest.json` with app specific info.
+* Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts, and any relevant conf files in `conf/`.
+  * Using the [script helpers documentation.](https://yunohost.org/packaging_apps_helpers)
+* Add a `LICENSE` file for the package.
+* Edit `doc/DISCLAIMER*.md`
+* The `README.md` files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
 
 ---
-
 <!--
 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.
@@ -19,30 +16,34 @@ It shall NOT be edited by hand.
 
 # Example app for YunoHost
 
-[![Integration level](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![](https://ci-apps.yunohost.org/ci/badges/example.status.svg)  ![](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg)
-[![Install example with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example)
+[![Integration level](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![Working status](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg)  
+[![Install Example app with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example)
 
 *[Lire ce readme en français.](./README_fr.md)*
 
-> *This package allows you to install example quickly and simply on a YunoHost server.
+> *This package allows you to install Example app 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
 
-Explain in *a few (10~15) words* the purpose of the app or what it actually does (it is meant to give a rough idea to users browsing a catalog of 100+ apps)
+Some long and extensive description of what the app is and does, lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+
+### Features
+
+- Ut enim ad minim veniam, quis nostrud exercitation ullamco ;
+- Laboris nisi ut aliquip ex ea commodo consequat ;
+- Duis aute irure dolor in reprehenderit in voluptate ;
+- Velit esse cillum dolore eu fugiat nulla pariatur ;
+- Excepteur sint occaecat cupidatat non proident, sunt in culpa."
+
 
 **Shipped version:** 1.0~ynh1
 
 **Demo:** https://demo.example.com
 
-
 ## Screenshots
 
-
-   ![](./doc/screenshots/example.jpg)
-
-
-
+![Screenshot of Example app](./doc/screenshots/example.jpg)
 
 ## Disclaimers / important information
 
@@ -59,26 +60,25 @@ Explain in *a few (10~15) words* the purpose of the app or what it actually does
     * upgrade process / specificities / things to be aware of ?
     * security considerations ?
 
-
-
 ## Documentation and resources
 
-* Official app website: https://example.com
-* Official user documentation: https://yunohost.org/apps
-* Official admin documentation: https://yunohost.org/packaging_apps
-* Upstream app code repository:  https://some.forge.com/example/example
-* YunoHost documentation for this app: https://yunohost.org/app_example
-* Report a bug: https://github.com/YunoHost-Apps/example_ynh/issues
+* Official app website: <https://example.com>
+* Official user documentation: <https://yunohost.org/apps>
+* Official admin documentation: <https://yunohost.org/packaging_apps>
+* Upstream app code repository: <https://some.forge.com/example/example>
+* YunoHost documentation for this app: <https://yunohost.org/app_example>
+* Report a bug: <https://github.com/YunoHost-Apps/example_ynh/issues>
 
 ## Developer info
 
 Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/example_ynh/tree/testing).
 
 To try the testing branch, please proceed like that.
-```
+
+``` bash
 sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
 or
 sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
 ```
 
-**More info regarding app packaging:** https://yunohost.org/packaging_apps
+**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
diff --git a/README_fr.md b/README_fr.md
index d856bf9..a1bebdc 100644
--- a/README_fr.md
+++ b/README_fr.md
@@ -1,30 +1,38 @@
+<!--
+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.
+-->
+
 # Example app pour YunoHost
 
-[![Niveau d'intégration](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![](https://ci-apps.yunohost.org/ci/badges/example.status.svg)  ![](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg)
-[![Installer example avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example)
+[![Niveau d'intégration](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg)  
+[![Installer Example app avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example)
 
 *[Read this readme in english.](./README.md)*
-*[Lire ce readme en français.](./README_fr.md)*
 
-> *This package allows you to install example 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.*
+> *Ce package vous permet d'installer Example app 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
 
-Expliquez en *quelques* (10~15) mots l'utilité de l'app ou ce qu'elle fait (l'objectif est de donner une idée grossière pour des utilisateurs qui naviguent dans un catalogue de 100+ apps)
+Some long and extensive description of what the app is and does, lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
 
-**Version incluse:** 1.0~ynh1
+### Features
 
-**Démo:** https://demo.example.com
+- Ut enim ad minim veniam, quis nostrud exercitation ullamco ;
+- Laboris nisi ut aliquip ex ea commodo consequat ;
+- Duis aute irure dolor in reprehenderit in voluptate ;
+- Velit esse cillum dolore eu fugiat nulla pariatur ;
+- Excepteur sint occaecat cupidatat non proident, sunt in culpa."
 
 
+**Version incluse :** 1.0~ynh1
+
+**Démo :** https://demo.example.com
+
 ## Captures d'écran
 
-
-   ![](./doc/screenshots/example.jpg)
-
-
-
+![Capture d'écran de Example app](./doc/screenshots/example.jpg)
 
 ## Avertissements / informations importantes
 
@@ -41,26 +49,25 @@ Expliquez en *quelques* (10~15) mots l'utilité de l'app ou ce qu'elle fait (l'o
     * upgrade process / specificities / things to be aware of ?
     * security considerations ?
 
-
-
 ## Documentations et ressources
 
-* Site official de l'app : https://example.com
-* Documentation officielle utilisateur: https://yunohost.org/apps
-* Documentation officielle de l'admin: https://yunohost.org/packaging_apps
-* Dépôt de code officiel de l'app:  https://some.forge.com/example/example
-* Documentation YunoHost pour cette app: https://yunohost.org/app_example
-* Signaler un bug: https://github.com/YunoHost-Apps/example_ynh/issues
+* Site officiel de l'app : <https://example.com>
+* Documentation officielle utilisateur : <https://yunohost.org/apps>
+* Documentation officielle de l'admin : <https://yunohost.org/packaging_apps>
+* Dépôt de code officiel de l'app : <https://some.forge.com/example/example>
+* Documentation YunoHost pour cette app : <https://yunohost.org/app_example>
+* Signaler un bug : <https://github.com/YunoHost-Apps/example_ynh/issues>
 
 ## Informations pour les développeurs
 
 Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/example_ynh/tree/testing).
 
 Pour essayer la branche testing, procédez comme suit.
-```
+
+``` bash
 sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
-or
+ou
 sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_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 :** <https://yunohost.org/packaging_apps>

From bcabe4e683f30dc3a84528b46ebbc32073139d57 Mon Sep 17 00:00:00 2001
From: yalh76 <yalh@yahoo.com>
Date: Tue, 7 Jun 2022 22:48:00 +0200
Subject: [PATCH 2/3] Update README_fr.md

Co-authored-by: tituspijean <tituspijean@outlook.com>
---
 README_fr.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README_fr.md b/README_fr.md
index a1bebdc..4da6fb7 100644
--- a/README_fr.md
+++ b/README_fr.md
@@ -3,7 +3,7 @@ N.B.: This README was automatically generated by https://github.com/YunoHost/app
 It shall NOT be edited by hand.
 -->
 
-# Example app pour YunoHost
+# Exemple d'app pour YunoHost
 
 [![Niveau d'intégration](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg)  
 [![Installer Example app avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example)

From 3056373bf70c7851546adb3fe451d368fd96cdbc Mon Sep 17 00:00:00 2001
From: yalh76 <yalh@yahoo.com>
Date: Tue, 7 Jun 2022 22:49:04 +0200
Subject: [PATCH 3/3] Update README.md

Co-authored-by: tituspijean <tituspijean@outlook.com>
---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index ad5c05b..5d8ccc7 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# Packaging your an app, starting from this example
+# Packaging an app, starting from this example
 
 * Copy this app before working on it, using the ['Use this template'](https://github.com/YunoHost/example_ynh/generate) button on the Github repo.
 * Edit the `manifest.json` with app specific info.