Auto-update README

2024-09-03 20:16:22 +02:00 · 2022-06-17 09:46:42 +00:00 · 2022-06-17 09:46:42 +00:00 · 35fab128c8
commit 35fab128c8
parent 25f2056577
2 changed files with 43 additions and 71 deletions
--- a/README.md
+++ b/README.md
@ -1,48 +1,27 @@
-
-# Packaging your an app, starting from this example
-
- Copy this app before working on it, using the ['Use this template'](https://github.com/YunoHost/example_ynh/generate) button on the Github repo.
- Edit the `manifest.json` with app specific info.
- Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts, and any relevant conf files in `conf/`.
-  - Using the [script helpers documentation.](https://yunohost.org/packaging_apps_helpers)
- Add a `LICENSE` file for the package.
- Edit `doc/DISCLAIMER*.md`
- The `README.md` files are to be 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/tree/master/tools/README-generator
 It shall NOT be edited by hand.
 -->

-# Example app for YunoHost
+# Shlink for YunoHost

-[![Integration level](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![](https://ci-apps.yunohost.org/ci/badges/example.status.svg)  ![](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg)
-[![Install example with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example)
+[![Integration level](https://dash.yunohost.org/integration/shlink.svg)](https://dash.yunohost.org/appci/app/shlink) ![Working status](https://ci-apps.yunohost.org/ci/badges/shlink.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/shlink.maintain.svg)  
+[![Install Shlink with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=shlink)

 *[Lire ce readme en français.](./README_fr.md)*

-> *This package allows you to install example quickly and simply on a YunoHost server.
+> *This package allows you to install Shlink 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

-Explain in *a few (10~15) words* the purpose of the app or what it actually does (it is meant to give a rough idea to users browsing a catalog of 100+ apps)
-
-**Shipped version:** 1.0~ynh1
-
-**Demo:** https://demo.example.com
+The definitive self-hosted URL shortener

+**Shipped version:** 3.1.2~ynh1

 ## Screenshots

-
-   ![](./doc/screenshots/example.jpg)
-
-
-
+![Screenshot of Shlink](./doc/screenshots/shlink-web-client-placeholder.jpg)

 ## Disclaimers / important information

@ -59,26 +38,24 @@ Explain in *a few (10~15) words* the purpose of the app or what it actually does
    * upgrade process / specificities / things to be aware of ?
    * security considerations ?

-
-
 ## Documentation and resources

-* Official app website: https://example.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_example
-* Report a bug: https://github.com/YunoHost-Apps/example_ynh/issues
+* Official app website: <https://shlink.io/>
+* Official user documentation: <https://shlink.io/documentation/>
+* Upstream app code repository: <https://github.com/shlinkio/shlink>
+* YunoHost documentation for this app: <https://yunohost.org/app_shlink>
+* Report a bug: <https://github.com/YunoHost-Apps/shlink_ynh/issues>

 ## Developer info

-Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/example_ynh/tree/testing).
+Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/shlink_ynh/tree/testing).

 To try the testing branch, please proceed like that.
-```
-sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
+
+``` bash
+sudo yunohost app install https://github.com/YunoHost-Apps/shlink_ynh/tree/testing --debug
 or
-sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
+sudo yunohost app upgrade shlink -u https://github.com/YunoHost-Apps/shlink_ynh/tree/testing --debug
 ```

-**More info regarding app packaging:** https://yunohost.org/packaging_apps
+**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
--- a/README_fr.md
+++ b/README_fr.md
@ -1,30 +1,27 @@
-# Example app pour YunoHost
+<!--
+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.
+-->

-[![Niveau d'intégration](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![](https://ci-apps.yunohost.org/ci/badges/example.status.svg)  ![](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg)
-[![Installer example avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example)
+# Shlink pour YunoHost
+
+[![Niveau d'intégration](https://dash.yunohost.org/integration/shlink.svg)](https://dash.yunohost.org/appci/app/shlink) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/shlink.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/shlink.maintain.svg)  
+[![Installer Shlink avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=shlink)

 *[Read this readme in english.](./README.md)*
-*[Lire ce readme en français.](./README_fr.md)*

-> *This package allows you to install example 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.*
+> *Ce package vous permet d'installer Shlink 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

-Expliquez en *quelques* (10~15) mots l'utilité de l'app ou ce qu'elle fait (l'objectif est de donner une idée grossière pour des utilisateurs qui naviguent dans un catalogue de 100+ apps)
-
-**Version incluse:** 1.0~ynh1
-
-**Démo:** https://demo.example.com
+The definitive self-hosted URL shortener

+**Version incluse :** 3.1.2~ynh1

 ## Captures d'écran

-
-   ![](./doc/screenshots/example.jpg)
-
-
-
+![Capture d'écran de Shlink](./doc/screenshots/shlink-web-client-placeholder.jpg)

 ## Avertissements / informations importantes

@ -41,26 +38,24 @@ Expliquez en *quelques* (10~15) mots l'utilité de l'app ou ce qu'elle fait (l'o
    * upgrade process / specificities / things to be aware of ?
    * security considerations ?

-
-
 ## Documentations et ressources

-* Site official de l'app : https://example.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_example
-* Signaler un bug: https://github.com/YunoHost-Apps/example_ynh/issues
+* Site officiel de l'app : <https://shlink.io/>
+* Documentation officielle utilisateur : <https://shlink.io/documentation/>
+* Dépôt de code officiel de l'app : <https://github.com/shlinkio/shlink>
+* Documentation YunoHost pour cette app : <https://yunohost.org/app_shlink>
+* Signaler un bug : <https://github.com/YunoHost-Apps/shlink_ynh/issues>

 ## Informations pour les développeurs

-Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/example_ynh/tree/testing).
+Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/shlink_ynh/tree/testing).

 Pour essayer la branche testing, procédez comme suit.
-```
-sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
-or
-sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
+
+``` bash
+sudo yunohost app install https://github.com/YunoHost-Apps/shlink_ynh/tree/testing --debug
+ou
+sudo yunohost app upgrade shlink -u https://github.com/YunoHost-Apps/shlink_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>