From 5f0a4e2762b8443eb8bf1af925fc8539938a0296 Mon Sep 17 00:00:00 2001
From: Yunohost-Bot <>
Date: Mon, 5 Jul 2021 06:23:49 +0000
Subject: [PATCH] Auto-update README

---
 README.md    | 46 +++++++++++++++++++++++++++++++++-------------
 README_fr.md | 40 ++++++++++++++++++++++++++++++++++++++++
 2 files changed, 73 insertions(+), 13 deletions(-)
 create mode 100644 README_fr.md

diff --git a/README.md b/README.md
index fb4d256..66a9741 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,44 @@
-# PHPBoost app for YunoHost
-PHPBoost
+<!--
+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.
+-->
 
-NOT WORK IS IN DEV
+# PHPBoost for YunoHost
 
-- [Yunohost project](https://yunohost.org)
-- [PHPBoost website](https://www.phpboost.com/)
+[![Integration level](https://dash.yunohost.org/integration/phpboost.svg)](https://dash.yunohost.org/appci/app/phpboost) ![](https://ci-apps.yunohost.org/ci/badges/phpboost.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/phpboost.maintain.svg)  
+[![Install PHPBoost with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=phpboost)
 
-![](https://www.phpboost.com/templates/phpboost52/theme/images/logo.png)
+*[Lire ce readme en français.](./README_fr.md)*
 
+> *This package allows you to install PHPBoost 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.*
 
-[![Install PHPBoost with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=phpboost)
+## Overview
 
-### Installing guide
+PHPBoost package for YunoHost.
 
- 1. App can be installed by YunoHost **admin web-interface** or by **running following command**:
+**Shipped version:** 6.0~ynh1
 
-         $ sudo yunohost app install https://github.com/YunoHost-Apps/phpboost_ynh
+**Demo:** https://demo.example.com
 
- 
-### Upgrade this package:
+## Documentation and resources
 
-        $ sudo yunohost app upgrade phpboost -u https://github.com/YunoHost-Apps/phpboost_ynh
+* Official app website: https://www.phpboost.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_phpboost
+* Report a bug: https://github.com/YunoHost-Apps/phpboost_ynh/issues
 
+## Developer info
+
+Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/phpboost_ynh/tree/testing).
+
+To try the testing branch, please proceed like that.
+```
+sudo yunohost app install https://github.com/YunoHost-Apps/phpboost_ynh/tree/testing --debug
+or
+sudo yunohost app upgrade phpboost -u https://github.com/YunoHost-Apps/phpboost_ynh/tree/testing --debug
+```
+
+**More info regarding app packaging:** https://yunohost.org/packaging_apps
\ No newline at end of file
diff --git a/README_fr.md b/README_fr.md
new file mode 100644
index 0000000..e0de5a3
--- /dev/null
+++ b/README_fr.md
@@ -0,0 +1,40 @@
+# PHPBoost pour YunoHost
+
+[![Niveau d'intégration](https://dash.yunohost.org/integration/phpboost.svg)](https://dash.yunohost.org/appci/app/phpboost) ![](https://ci-apps.yunohost.org/ci/badges/phpboost.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/phpboost.maintain.svg)  
+[![Installer PHPBoost avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=phpboost)
+
+*[Read this readme in english.](./README.md)*
+*[Lire ce readme en français.](./README_fr.md)*
+
+> *Ce package vous permet d'installer PHPBoost 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
+
+PHPBoost pour YunoHost.
+
+**Version incluse :** 6.0~ynh1
+
+**Démo :** https://demo.example.com
+
+## Documentations et ressources
+
+* Site officiel de l'app : https://www.phpboost.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_phpboost
+* Signaler un bug : https://github.com/YunoHost-Apps/phpboost_ynh/issues
+
+## Informations pour les développeurs
+
+Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/phpboost_ynh/tree/testing).
+
+Pour essayer la branche testing, procédez comme suit.
+```
+sudo yunohost app install https://github.com/YunoHost-Apps/phpboost_ynh/tree/testing --debug
+ou
+sudo yunohost app upgrade phpboost -u https://github.com/YunoHost-Apps/phpboost_ynh/tree/testing --debug
+```
+
+**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
\ No newline at end of file