Browse Source

Auto-update README

yunohost-bot 3 years ago
parent
commit
548d81bdad
2 changed files with 25 additions and 23 deletions
  1. 10 11
      README.md
  2. 15 12
      README_fr.md

+ 10 - 11
README.md

@@ -5,7 +5,7 @@ It shall NOT be edited by hand.
 
 # Pi-hole for YunoHost
 
-[![Integration level](https://dash.yunohost.org/integration/pihole.svg)](https://dash.yunohost.org/appci/app/pihole) ![](https://ci-apps.yunohost.org/ci/badges/pihole.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/pihole.maintain.svg)  
+[![Integration level](https://dash.yunohost.org/integration/pihole.svg)](https://dash.yunohost.org/appci/app/pihole) ![Working status](https://ci-apps.yunohost.org/ci/badges/pihole.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/pihole.maintain.svg)  
 [![Install Pi-hole with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pihole)
 
 *[Lire ce readme en français.](./README_fr.md)*
@@ -19,11 +19,9 @@ The Pi-hole® is a DNS sinkhole that protects your devices from unwanted content
 
 **Shipped version:** 5.10~ynh1
 
-
-
 ## Screenshots
 
-![](./doc/screenshots/dashboard.png)
+![Screenshot of Pi-hole](./doc/screenshots/dashboard.png)
 
 ## Disclaimers / important information
 
@@ -90,21 +88,22 @@ sudo ifconfig eth0 0.0.0.0 && sudo dhclient eth0
 > Don't forget to turn off the DHCP of your router if your server is working again.
 ## Documentation and resources
 
-* Official app website: https://pi-hole.net/
-* Official admin documentation: https://docs.pi-hole.net
-* Upstream app code repository: https://github.com/pi-hole/pi-hole/
-* YunoHost documentation for this app: https://yunohost.org/app_pihole
-* Report a bug: https://github.com/YunoHost-Apps/pihole_ynh/issues
+* Official app website: <https://pi-hole.net/>
+* Official admin documentation: <https://docs.pi-hole.net>
+* Upstream app code repository: <https://github.com/pi-hole/pi-hole/>
+* YunoHost documentation for this app: <https://yunohost.org/app_pihole>
+* Report a bug: <https://github.com/YunoHost-Apps/pihole_ynh/issues>
 
 ## Developer info
 
 Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/pihole_ynh/tree/testing).
 
 To try the testing branch, please proceed like that.
-```
+
+``` bash
 sudo yunohost app install https://github.com/YunoHost-Apps/pihole_ynh/tree/testing --debug
 or
 sudo yunohost app upgrade pihole -u https://github.com/YunoHost-Apps/pihole_ynh/tree/testing --debug
 ```
 
-**More info regarding app packaging:** https://yunohost.org/packaging_apps
+**More info regarding app packaging:** <https://yunohost.org/packaging_apps>

+ 15 - 12
README_fr.md

@@ -1,10 +1,14 @@
+<!--
+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.
+-->
+
 # Pi-hole pour YunoHost
 
-[![Niveau d'intégration](https://dash.yunohost.org/integration/pihole.svg)](https://dash.yunohost.org/appci/app/pihole) ![](https://ci-apps.yunohost.org/ci/badges/pihole.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/pihole.maintain.svg)  
+[![Niveau d'intégration](https://dash.yunohost.org/integration/pihole.svg)](https://dash.yunohost.org/appci/app/pihole) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/pihole.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/pihole.maintain.svg)  
 [![Installer Pi-hole avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pihole)
 
 *[Read this readme in english.](./README.md)*
-*[Lire ce readme en français.](./README_fr.md)*
 
 > *Ce package vous permet d'installer Pi-hole 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.*
@@ -15,11 +19,9 @@ The Pi-hole® is a DNS sinkhole that protects your devices from unwanted content
 
 **Version incluse :** 5.10~ynh1
 
-
-
 ## Captures d'écran
 
-![](./doc/screenshots/dashboard.png)
+![Capture d'écran de Pi-hole](./doc/screenshots/dashboard.png)
 
 ## Avertissements / informations importantes
 
@@ -87,21 +89,22 @@ sudo ifconfig eth0 0.0.0.0 && sudo dhclient eth0
 
 ## Documentations et ressources
 
-* Site officiel de l'app : https://pi-hole.net/
-* Documentation officielle de l'admin : https://docs.pi-hole.net
-* Dépôt de code officiel de l'app : https://github.com/pi-hole/pi-hole/
-* Documentation YunoHost pour cette app : https://yunohost.org/app_pihole
-* Signaler un bug : https://github.com/YunoHost-Apps/pihole_ynh/issues
+* Site officiel de l'app : <https://pi-hole.net/>
+* Documentation officielle de l'admin : <https://docs.pi-hole.net>
+* Dépôt de code officiel de l'app : <https://github.com/pi-hole/pi-hole/>
+* Documentation YunoHost pour cette app : <https://yunohost.org/app_pihole>
+* Signaler un bug : <https://github.com/YunoHost-Apps/pihole_ynh/issues>
 
 ## Informations pour les développeurs
 
 Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/pihole_ynh/tree/testing).
 
 Pour essayer la branche testing, procédez comme suit.
-```
+
+``` bash
 sudo yunohost app install https://github.com/YunoHost-Apps/pihole_ynh/tree/testing --debug
 ou
 sudo yunohost app upgrade pihole -u https://github.com/YunoHost-Apps/pihole_ynh/tree/testing --debug
 ```
 
-**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
+**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps>