From d04fa8bcf69273c82116b1a29bfd4e5e744d15b9 Mon Sep 17 00:00:00 2001
From: Yunohost-Bot <>
Date: Tue, 6 Jul 2021 08:57:28 +0000
Subject: [PATCH] Auto-update README

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

diff --git a/README.md b/README.md
index aa75bad..50ef6d1 100644
--- a/README.md
+++ b/README.md
@@ -1,27 +1,44 @@
-# phpIPAM app for YunoHost
-phpIPAM Server
+<!--
+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.
+-->
 
-**Shipped version:** 1.4
+# phpIPAM for YunoHost
 
-- [Yunohost project](https://yunohost.org)
-- [phpIPAM website](https://phpipam.net/)
+[![Integration level](https://dash.yunohost.org/integration/phpipam.svg)](https://dash.yunohost.org/appci/app/phpipam) ![](https://ci-apps.yunohost.org/ci/badges/phpipam.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/phpipam.maintain.svg)  
+[![Install phpIPAM with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=phpipam)
 
-![](https://phpipam.net/css/images/phpipam_logo_small@2x.png)
+*[Lire ce readme en français.](./README_fr.md)*
 
+> *This package allows you to install phpIPAM 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 phpIPAM with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=phpipam)
+## Overview
 
-### Installing guide
+Web IP address management application
 
- App can be installed by YunoHost **admin web-interface** or by **running following command**:
+**Shipped version:** 1.4.3~ynh1
 
-        $ sudo yunohost app install https://github.com/YunoHost-Apps/phpipam_ynh
-         
-        1. Login in phpIPAM
-        2. Default user : admin password : ipamadmin
+**Demo:** https://demo.example.com
 
- 
-### Upgrade this package:
+## Documentation and resources
 
-        $ sudo yunohost app upgrade phpipam -u https://github.com/YunoHost-Apps/phpipam_ynh
+* Official app website: https://phpipam.net/
+* 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_phpipam
+* Report a bug: https://github.com/YunoHost-Apps/phpipam_ynh/issues
 
+## Developer info
+
+Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/phpipam_ynh/tree/testing).
+
+To try the testing branch, please proceed like that.
+```
+sudo yunohost app install https://github.com/YunoHost-Apps/phpipam_ynh/tree/testing --debug
+or
+sudo yunohost app upgrade phpipam -u https://github.com/YunoHost-Apps/phpipam_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..3ff9e78
--- /dev/null
+++ b/README_fr.md
@@ -0,0 +1,40 @@
+# phpIPAM pour YunoHost
+
+[![Niveau d'intégration](https://dash.yunohost.org/integration/phpipam.svg)](https://dash.yunohost.org/appci/app/phpipam) ![](https://ci-apps.yunohost.org/ci/badges/phpipam.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/phpipam.maintain.svg)  
+[![Installer phpIPAM avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=phpipam)
+
+*[Read this readme in english.](./README.md)*
+*[Lire ce readme en français.](./README_fr.md)*
+
+> *Ce package vous permet d'installer phpIPAM 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
+
+Application web de gestion d'adresses IP
+
+**Version incluse :** 1.4.3~ynh1
+
+**Démo :** https://demo.example.com
+
+## Documentations et ressources
+
+* Site officiel de l'app : https://phpipam.net/
+* 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_phpipam
+* Signaler un bug : https://github.com/YunoHost-Apps/phpipam_ynh/issues
+
+## Informations pour les développeurs
+
+Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/phpipam_ynh/tree/testing).
+
+Pour essayer la branche testing, procédez comme suit.
+```
+sudo yunohost app install https://github.com/YunoHost-Apps/phpipam_ynh/tree/testing --debug
+ou
+sudo yunohost app upgrade phpipam -u https://github.com/YunoHost-Apps/phpipam_ynh/tree/testing --debug
+```
+
+**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
\ No newline at end of file