Browse Source

Auto-update READMEs

yunohost-bot 10 months ago
parent
commit
1e342c6f82
2 changed files with 25 additions and 46 deletions
  1. 0 12
      ALL_README.md
  2. 25 34
      README.md

+ 0 - 12
ALL_README.md

@@ -1,12 +0,0 @@
-# All available README files by language
-
-- [Read the README in English](README.md)
-- [Lea el README en español](README_es.md)
-- [Irakurri README euskaraz](README_eu.md)
-- [Lire le README en français](README_fr.md)
-- [Le o README en galego](README_gl.md)
-- [Baca README dalam bahasa bahasa Indonesia](README_id.md)
-- [Lees de README in het Nederlands](README_nl.md)
-- [Przeczytaj README w języku polski](README_pl.md)
-- [Прочитать README на русский](README_ru.md)
-- [阅读中文(简体)的 README](README_zh_Hans.md)

+ 25 - 34
README.md

@@ -1,53 +1,44 @@
 <!--
-N.B.: This README was 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_tools/blob/main/readme_generator>
 It shall NOT be edited by hand.
 -->
 
-# Pi-hole for YunoHost
+<h1>
+  <img src="https://raw.githubusercontent.com/YunoHost/apps/main/logos/pihole.png" width="32px" alt="Logo of Pi-hole">
+  Pi-hole, packaged for YunoHost
+</h1>
 
-[![Integration level](https://apps.yunohost.org/badge/integration/pihole)](https://ci-apps.yunohost.org/ci/apps/pihole/)
-![Working status](https://apps.yunohost.org/badge/state/pihole)
-![Maintenance status](https://apps.yunohost.org/badge/maintained/pihole)
+Network-wide ad blocking via your own DNS server
 
-[![Install Pi-hole with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pihole)
+[![🌐 Official app website](https://img.shields.io/badge/Official_app_website-darkgreen?style=for-the-badge)](https://pi-hole.net/)
+[![Version: 5.18.4~ynh1](https://img.shields.io/badge/Version-5.18.4~ynh1-rgb(18,138,11)?style=for-the-badge)](https://ci-apps.yunohost.org/ci/apps/pihole/)
 
-*[Read this README in other languages.](./ALL_README.md)*
+<div align="center">
+<a href="https://apps.yunohost.org/app/pihole"><img height="100px" src="https://github.com/YunoHost/yunohost-artwork/raw/refs/heads/main/badges/neopossum-badges/badge_more_info_on_the_appstore.svg"/></a>
+<a href="https://github.com/YunoHost-Apps/pihole_ynh/issues"><img height="100px" src="https://github.com/YunoHost/yunohost-artwork/raw/refs/heads/main/badges/neopossum-badges/badge_report_an_issue.svg"/></a>
+</div>
 
-> *This package allows you to install Pi-hole 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
-
-The Pi-hole® is a DNS sinkhole that protects your devices from unwanted content without installing any client-side software.
-
-**Shipped version:** 5.18.4~ynh1
 
 ## Screenshots
-
 ![Screenshot of Pi-hole](./doc/screenshots/dashboard.png)
 
-## :red_circle: Antifeatures
+## 📦 Developer info
 
-- **Package not maintained**: This YunoHost package is not actively maintained and needs adoption. This means that minimal maintenance is made by volunteers who don't use the app, so you should expect the app to lose reliability over time. You can [learn how to package](https://yunohost.org/packaging_apps_intro) if you'd like to adopt it.
+[![Automatic tests level](https://apps.yunohost.org/badge/cilevel/pihole)](https://ci-apps.yunohost.org/ci/apps/pihole/)
 
-## Documentation and resources
+🛠️ Upstream Pi-hole repository: <https://github.com/pi-hole/pi-hole>
 
-- 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 Store: <https://apps.yunohost.org/app/pihole>
-- Report a bug: <https://github.com/YunoHost-Apps/pihole_ynh/issues>
+Pull request are welcome and should target the [`testing` branch](https://github.com/YunoHost-Apps/pihole_ynh/tree/testing).
 
-## 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:
+The `testing` branch can be tested using:
+```
+# fresh install:
+sudo yunohost app install https://github.com/YunoHost-Apps/pihole_ynh/tree/testing
 
-```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
+# upgrade an existing install:
+sudo yunohost app upgrade pihole -u https://github.com/YunoHost-Apps/pihole_ynh/tree/testing
 ```
 
-**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
+### 📚 App packaging documentation
+
+Please see <https://doc.yunohost.org/packaging_apps> for more information.