From 5898ad81a5bba9a4283df4e94b9d292be3a76bfa Mon Sep 17 00:00:00 2001
From: Yunohost-Bot <>
Date: Sun, 8 Aug 2021 07:56:42 +0000
Subject: [PATCH] Auto-update README

---
 README.md    | 50 ++++++++++++++++++++++++++++++++++----------------
 README_fr.md | 44 ++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 78 insertions(+), 16 deletions(-)
 create mode 100644 README_fr.md

diff --git a/README.md b/README.md
index d762e71..d878981 100644
--- a/README.md
+++ b/README.md
@@ -1,30 +1,48 @@
-# AdGuard Home app for YunoHost
-AdGuard Home 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:** 0.104.1
+# AdGuard Home for YunoHost
 
-- [Yunohost project](https://yunohost.org)
-- [AdGuard Home website](https://github.com/AdguardTeam/AdGuardHome)
+[![Integration level](https://dash.yunohost.org/integration/adguardhome.svg)](https://dash.yunohost.org/appci/app/adguardhome) ![](https://ci-apps.yunohost.org/ci/badges/adguardhome.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/adguardhome.maintain.svg)  
+[![Install AdGuard Home with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=adguardhome)
 
-![](https://camo.githubusercontent.com/c6c427a65dd6a52d092015fff9205e148130aa94/68747470733a2f2f63646e2e616467756172642e636f6d2f7075626c69632f416467756172642f436f6d6d6f6e2f616467756172645f686f6d652e737667)
+*[Lire ce readme en français.](./README_fr.md)*
 
+> *This package allows you to install AdGuard Home 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 AdGuard Home with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=adguard)
+## Overview
 
-### Installing guide
+Network-wide ads & trackers blocking DNS server
 
- App can be installed by YunoHost **admin web-interface** or by **running following command**:
+**Shipped version:** 0.106.3~ynh1
 
-         $ sudo yunohost app install https://github.com/YunoHost-Apps/adguard_ynh
+**Demo:** https://demo.example.com
 
- Fail to start ? try :
+## Screenshots
 
-         $ systemctl status adguard
-         $ apt install -y net-tools
-         $ netstat -tlnp | grep 53
+![](./doc/screenshots/68747470733a2f2f63646e2e616467756172642e636f6d2f7075626c69632f416467756172642f436f6d6d6f6e2f616467756172645f686f6d652e676966.gif)
 
+## Documentation and resources
 
-### Upgrade this package:
+* Official app website: https://adguard.com/adguard-home.html
+* Official user documentation: https://yunohost.org/apps
+* Official admin documentation: https://yunohost.org/packaging_apps
+* Upstream app code repository: https://github.com/AdguardTeam/AdGuardHome
+* YunoHost documentation for this app: https://yunohost.org/app_adguardhome
+* Report a bug: https://github.com/YunoHost-Apps/adguardhome_ynh/issues
 
-        $ sudo yunohost app upgrade adguard -u https://github.com/YunoHost-Apps/adguard_ynh
+## Developer info
 
+Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/adguardhome_ynh/tree/testing).
+
+To try the testing branch, please proceed like that.
+```
+sudo yunohost app install https://github.com/YunoHost-Apps/adguardhome_ynh/tree/testing --debug
+or
+sudo yunohost app upgrade adguardhome -u https://github.com/YunoHost-Apps/adguardhome_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..3ba44ff
--- /dev/null
+++ b/README_fr.md
@@ -0,0 +1,44 @@
+# AdGuard Home pour YunoHost
+
+[![Niveau d'intégration](https://dash.yunohost.org/integration/adguardhome.svg)](https://dash.yunohost.org/appci/app/adguardhome) ![](https://ci-apps.yunohost.org/ci/badges/adguardhome.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/adguardhome.maintain.svg)  
+[![Installer AdGuard Home avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=adguardhome)
+
+*[Read this readme in english.](./README.md)*
+*[Lire ce readme en français.](./README_fr.md)*
+
+> *Ce package vous permet d'installer AdGuard Home 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
+
+AdGuard Home pour YunoHost.
+
+**Version incluse :** 0.106.3~ynh1
+
+**Démo :** https://demo.example.com
+
+## Captures d'écran
+
+![](./doc/screenshots/68747470733a2f2f63646e2e616467756172642e636f6d2f7075626c69632f416467756172642f436f6d6d6f6e2f616467756172645f686f6d652e676966.gif)
+
+## Documentations et ressources
+
+* Site officiel de l'app : https://adguard.com/adguard-home.html
+* 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://github.com/AdguardTeam/AdGuardHome
+* Documentation YunoHost pour cette app : https://yunohost.org/app_adguardhome
+* Signaler un bug : https://github.com/YunoHost-Apps/adguardhome_ynh/issues
+
+## Informations pour les développeurs
+
+Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/adguardhome_ynh/tree/testing).
+
+Pour essayer la branche testing, procédez comme suit.
+```
+sudo yunohost app install https://github.com/YunoHost-Apps/adguardhome_ynh/tree/testing --debug
+ou
+sudo yunohost app upgrade adguardhome -u https://github.com/YunoHost-Apps/adguardhome_ynh/tree/testing --debug
+```
+
+**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
\ No newline at end of file