Auto-update README

README.md

@@ -1,51 +1,48 @@
+<!--
+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.
+-->
+
 # PeerTube search-index for YunoHost
 
 [![Integration level](https://dash.yunohost.org/integration/peertube-search-index.svg)](https://dash.yunohost.org/appci/app/peertube-search-index) ![](https://ci-apps.yunohost.org/ci/badges/peertube-search-index.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/peertube-search-index.maintain.svg)  
 [![Install PeerTube search-index with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=peertube-search-index)
 
-> *This package allows you to install PeerTube search-index quickly and simply on a YunoHost server.  
+*[Lire ce readme en français.](./README_fr.md)*
+
+> *This package allows you to install PeerTube search-index 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
+
 A search engine for [PeerTube](https://joinpeertube.org/) videos and channels, developed by Framasoft.
 
-**Shipped version:** 0.0.1-2021-02-17
+
+**Shipped version:** 2021.02.17~ynh3
+
+**Demo:** https://search.joinpeertube.org/
+
+## Screenshots
+
+![](./doc/screenshots/sepia-search-screenshot.png)
+
+## Disclaimers / important information
 
 ## Important points to read before installing
 
 1. **PeerTube search-index** require a dedicated **root domain**, eg. search.domain.tld
 
-## Screenshots
-
-![](sepia-search-screenshot.png)
-
-## Demo
-
-* [Official demo](https://search.joinpeertube.org/)
-
 ## Configuration
 
-To configure this app: modify the file /var/www/peertube-search-index/config/production.yaml with SSH.
+To configure this app: modify the file `/var/www/peertube-search-index/config/production.yaml` with SSH.
 
-## Documentation
+## Documentation and resources
 
- * Official documentation: https://framagit.org/framasoft/peertube/search-index
+* Official app website: https://search.joinpeertube.org/
-
+* Official admin documentation: https://framagit.org/framasoft/peertube/search-index
-## YunoHost specific features
+* Upstream app code repository: https://framagit.org/framasoft/peertube/search-index
-
+* YunoHost documentation for this app: https://yunohost.org/app_peertube-search-index
-#### Supported architectures
+* Report a bug: https://github.com/YunoHost-Apps/peertube-search-index_ynh/issues
-
-* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/peertube-search-index.svg)](https://ci-apps.yunohost.org/ci/apps/peertube-search-index/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/peertube-search-index.svg)](https://ci-apps-arm.yunohost.org/ci/apps/peertube-search-index/)
-
-## Links
-
- * Report a bug: https://github.com/YunoHost-Apps/peertube-search-index_ynh/issues
- * App website: https://search.joinpeertube.org/
- * Upstream app repository: https://framagit.org/framasoft/peertube/search-index
- * YunoHost website: https://yunohost.org/
-
----
 
 ## Developer info
 
@@ -57,3 +54,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/peertube-search-index
 or
 sudo yunohost app upgrade peertube-search-index -u https://github.com/YunoHost-Apps/peertube-search-index_ynh/tree/testing --debug
 ```
+
+**More info regarding app packaging:** https://yunohost.org/packaging_apps

README_fr.md

@@ -0,0 +1,54 @@
+# PeerTube search-index pour YunoHost
+
+[![Niveau d'intégration](https://dash.yunohost.org/integration/peertube-search-index.svg)](https://dash.yunohost.org/appci/app/peertube-search-index) ![](https://ci-apps.yunohost.org/ci/badges/peertube-search-index.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/peertube-search-index.maintain.svg)  
+[![Installer PeerTube search-index avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=peertube-search-index)
+
+*[Read this readme in english.](./README.md)*
+*[Lire ce readme en français.](./README_fr.md)*
+
+> *Ce package vous permet d'installer PeerTube search-index 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
+
+A search engine for [PeerTube](https://joinpeertube.org/) videos and channels, developed by Framasoft.
+
+
+**Version incluse :** 2021.02.17~ynh3
+
+**Démo :** https://search.joinpeertube.org/
+
+## Captures d'écran
+
+![](./doc/screenshots/sepia-search-screenshot.png)
+
+## Avertissements / informations importantes
+
+## Important points to read before installing
+
+1. **PeerTube search-index** require a dedicated **root domain**, eg. search.domain.tld
+
+## Configuration
+
+To configure this app: modify the file `/var/www/peertube-search-index/config/production.yaml` with SSH.
+
+## Documentations et ressources
+
+* Site officiel de l'app : https://search.joinpeertube.org/
+* Documentation officielle de l'admin : https://framagit.org/framasoft/peertube/search-index
+* Dépôt de code officiel de l'app : https://framagit.org/framasoft/peertube/search-index
+* Documentation YunoHost pour cette app : https://yunohost.org/app_peertube-search-index
+* Signaler un bug : https://github.com/YunoHost-Apps/peertube-search-index_ynh/issues
+
+## Informations pour les développeurs
+
+Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/peertube-search-index_ynh/tree/testing).
+
+Pour essayer la branche testing, procédez comme suit.
+```
+sudo yunohost app install https://github.com/YunoHost-Apps/peertube-search-index_ynh/tree/testing --debug
+ou
+sudo yunohost app upgrade peertube-search-index -u https://github.com/YunoHost-Apps/peertube-search-index_ynh/tree/testing --debug
+```
+
+**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps