From f8732bb9b564d7220cc642537f93155bc162cb14 Mon Sep 17 00:00:00 2001
From: oufmilo <44617467+oufmilo@users.noreply.github.com>
Date: Wed, 29 Nov 2023 21:43:44 +0100
Subject: [PATCH] Add README

---
 README.md    | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 README_fr.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 105 insertions(+)
 create mode 100644 README.md
 create mode 100644 README_fr.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..182611d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,54 @@
+
+
+---
+<!--
+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
+
+[![Integration level](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![Working status](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg)
+
+[![Install Example app with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example)
+
+*[Lire ce readme en français.](./README_fr.md)*
+
+> *This package allows you to install Example app 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
+
+This is a dummy description of this app features
+
+
+**Shipped version:** 1.0~ynh1
+
+**Demo:** https://joinfirefish.org/
+
+## Screenshots
+
+![Screenshot of Example app](./doc/screenshots/screenshot-firefish.png)
+
+## 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>
+
+## Developer info
+
+Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/example_ynh/tree/testing).
+
+To try the testing branch, please proceed like that.
+
+``` bash
+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
+```
+
+**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
diff --git a/README_fr.md b/README_fr.md
new file mode 100644
index 0000000..3880bc4
--- /dev/null
+++ b/README_fr.md
@@ -0,0 +1,51 @@
+<!--
+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 pour YunoHost
+
+[![Niveau d’intégration](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg)
+
+[![Installer Example app avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example)
+
+*[Read this readme in english.](./README.md)*
+
+> *Ce package vous permet d’installer Example app 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
+
+Ceci est une fausse description des fonctionalités de l'app
+
+
+**Version incluse :** 1.0~ynh1
+
+**Démo :** https://demo.example.com
+
+## Captures d’écran
+
+![Capture d’écran de Example app](./doc/screenshots/example.jpg)
+
+## Documentations et ressources
+
+* Site officiel 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>
+
+## Informations pour les développeurs
+
+Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/example_ynh/tree/testing).
+
+Pour essayer la branche testing, procédez comme suit.
+
+``` bash
+sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
+ou
+sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
+```
+
+**Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>
\ No newline at end of file