From 1ba46068021f7401548dab9ad876e1c0ffed8e37 Mon Sep 17 00:00:00 2001
From: Yunohost-Bot <>
Date: Mon, 21 Feb 2022 22:21:17 +0000
Subject: [PATCH] Auto-update README

---
 README.md    | 47 ++++++++++++++++++++++++++++++++++++++++++-----
 README_fr.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 85 insertions(+), 5 deletions(-)
 create mode 100644 README_fr.md

diff --git a/README.md b/README.md
index bec3d2d..de958fd 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,47 @@
-YaCy package 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.
+-->
 
-* [YaCy web site](http://yacy.net)
+# YaCy for YunoHost
 
-* [YunoHost web site](https://yunohost.org/)
+[![Integration level](https://dash.yunohost.org/integration/yacy.svg)](https://dash.yunohost.org/appci/app/yacy) ![](https://ci-apps.yunohost.org/ci/badges/yacy.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/yacy.maintain.svg)  
+[![Install YaCy with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=yacy)
 
-* Package not ready
+*[Lire ce readme en français.](./README_fr.md)*
+
+> *This package allows you to install YaCy 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 YaCy search engine software provides results from a network of independent peers, instead of a central server. It is a distributed network where no single entity decides what to list or order it appears in.
 
 
+**Shipped version:** 1.0~ynh1
+
+
+
+## Screenshots
+
+![](./doc/screenshots/screenshot01.png)
+
+## Documentation and resources
+
+* Official app website: https://yacy.net/
+* Upstream app code repository: https://github.com/yacy/yacy_search_server
+* YunoHost documentation for this app: https://yunohost.org/app_yacy
+* Report a bug: https://github.com/YunoHost-Apps/yacy_ynh/issues
+
+## Developer info
+
+Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/yacy_ynh/tree/testing).
+
+To try the testing branch, please proceed like that.
+```
+sudo yunohost app install https://github.com/YunoHost-Apps/yacy_ynh/tree/testing --debug
+or
+sudo yunohost app upgrade yacy -u https://github.com/YunoHost-Apps/yacy_ynh/tree/testing --debug
+```
+
+**More info regarding app packaging:** https://yunohost.org/packaging_apps
\ No newline at end of file
diff --git a/README_fr.md b/README_fr.md
new file mode 100644
index 0000000..97000cb
--- /dev/null
+++ b/README_fr.md
@@ -0,0 +1,43 @@
+# YaCy pour YunoHost
+
+[![Niveau d'intégration](https://dash.yunohost.org/integration/yacy.svg)](https://dash.yunohost.org/appci/app/yacy) ![](https://ci-apps.yunohost.org/ci/badges/yacy.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/yacy.maintain.svg)  
+[![Installer YaCy avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=yacy)
+
+*[Read this readme in english.](./README.md)*
+*[Lire ce readme en français.](./README_fr.md)*
+
+> *Ce package vous permet d'installer YaCy 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
+
+The YaCy search engine software provides results from a network of independent peers, instead of a central server. It is a distributed network where no single entity decides what to list or order it appears in.
+
+
+**Version incluse :** 1.0~ynh1
+
+
+
+## Captures d'écran
+
+![](./doc/screenshots/screenshot01.png)
+
+## Documentations et ressources
+
+* Site officiel de l'app : https://yacy.net/
+* Dépôt de code officiel de l'app : https://github.com/yacy/yacy_search_server
+* Documentation YunoHost pour cette app : https://yunohost.org/app_yacy
+* Signaler un bug : https://github.com/YunoHost-Apps/yacy_ynh/issues
+
+## Informations pour les développeurs
+
+Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/yacy_ynh/tree/testing).
+
+Pour essayer la branche testing, procédez comme suit.
+```
+sudo yunohost app install https://github.com/YunoHost-Apps/yacy_ynh/tree/testing --debug
+ou
+sudo yunohost app upgrade yacy -u https://github.com/YunoHost-Apps/yacy_ynh/tree/testing --debug
+```
+
+**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
\ No newline at end of file