Merge branch 'example' of https://github.com/YunoHost-Apps/rspamdui_ynh into example

README.md

@@ -1,4 +1,42 @@
-Rspamd Web UI for 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.
+-->
 
-https://rspamd.com/webui/
+# Rspamd UI for YunoHost
+
+[![Integration level](https://dash.yunohost.org/integration/rspamdui.svg)](https://dash.yunohost.org/appci/app/rspamdui) ![](https://ci-apps.yunohost.org/ci/badges/rspamdui.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/rspamdui.maintain.svg)  
+[![Install Rspamd UI with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=rspamdui)
+
+*[Lire ce readme en français.](./README_fr.md)*
+
+> *This package allows you to install Rspamd UI 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
+
+Simple control interface for rspamd spam filtering system
+
+**Shipped version:** 1.0~ynh1
+
+
+
+## Documentation and resources
+
+* Official app website: https://rspamd.com/webui
+* Upstream app code repository: https://github.com/rspamd/rspamd
+* YunoHost documentation for this app: https://yunohost.org/app_rspamdui
+* Report a bug: https://github.com/YunoHost-Apps/rspamdui_ynh/issues
+
+## Developer info
+
+Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/rspamdui_ynh/tree/testing).
+
+To try the testing branch, please proceed like that.
+```
+sudo yunohost app install https://github.com/YunoHost-Apps/rspamdui_ynh/tree/testing --debug
+or
+sudo yunohost app upgrade rspamdui -u https://github.com/YunoHost-Apps/rspamdui_ynh/tree/testing --debug
+```
+
+**More info regarding app packaging:** https://yunohost.org/packaging_apps

README_fr.md

@@ -0,0 +1,38 @@
+# Rspamd UI pour YunoHost
+
+[![Niveau d'intégration](https://dash.yunohost.org/integration/rspamdui.svg)](https://dash.yunohost.org/appci/app/rspamdui) ![](https://ci-apps.yunohost.org/ci/badges/rspamdui.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/rspamdui.maintain.svg)  
+[![Installer Rspamd UI avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=rspamdui)
+
+*[Read this readme in english.](./README.md)*
+*[Lire ce readme en français.](./README_fr.md)*
+
+> *Ce package vous permet d'installer Rspamd UI 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
+
+Simple control interface for rspamd spam filtering system
+
+**Version incluse :** 1.0~ynh1
+
+
+
+## Documentations et ressources
+
+* Site officiel de l'app : https://rspamd.com/webui
+* Dépôt de code officiel de l'app : https://github.com/rspamd/rspamd
+* Documentation YunoHost pour cette app : https://yunohost.org/app_rspamdui
+* Signaler un bug : https://github.com/YunoHost-Apps/rspamdui_ynh/issues
+
+## Informations pour les développeurs
+
+Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/rspamdui_ynh/tree/testing).
+
+Pour essayer la branche testing, procédez comme suit.
+```
+sudo yunohost app install https://github.com/YunoHost-Apps/rspamdui_ynh/tree/testing --debug
+ou
+sudo yunohost app upgrade rspamdui -u https://github.com/YunoHost-Apps/rspamdui_ynh/tree/testing --debug
+```
+
+**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps