Auto-update README

README.md

@@ -1,7 +1,12 @@
+<!--
+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.
+-->
+
 # ZeroNet for YunoHost
 
-[![Integration level](https://dash.yunohost.org/integration/zeronet.svg)](https://dash.yunohost.org/appci/app/zeronet) ![](https://ci-apps.yunohost.org/ci/badges/zeronet.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/zeronet.maintain.svg)  
+[![Integration level](https://dash.yunohost.org/integration/zeronet.svg)](https://dash.yunohost.org/appci/app/zeronet) ![Working status](https://ci-apps.yunohost.org/ci/badges/zeronet.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/zeronet.maintain.svg)  
-[![Install ZeroNet with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=zeronet)
+[![Install ZeroNet with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=zeronet)
 
 *[Lire ce readme en français.](./README_fr.md)*
 
@@ -9,72 +14,48 @@
 If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
 
 ## Overview
+
 ZeroNet allows you to publish static and dynamic websites on a distributed web platform using Bitcoin crypto and the BitTorrent network.
 
-**Shipped version:** 2021-01-25
+
+**Shipped version:** 2021.01.25~ynh1
 
 ## Screenshots
 
-![](https://camo.githubusercontent.com/7b79b9725df29fa5403ba490ff9870e0464a00e106bad5536867602625ca94cc/68747470733a2f2f692e696d6775722e636f6d2f4836304f4148592e706e67)
+![Screenshot of ZeroNet](./doc/screenshots/screenshot.png)
 
+## Disclaimers / important information
 
 ## Install instructions
 - This app can only be installed on root path, i.e you will need to use a dedicated domain name, e.g.`zeronet.domain.tld`.
 - You can setup Tor which has to be done manually till its implimented in the app.[how to use zeronet with Tor](https://zeronet.readthedocs.io/en/latest/faq/#how-to-use-zeronet-with-tor)
 
-
 ## Multiple Instances
 - Installing multiple instances of the app is *experimental*. Internally each instance will use an unique port for both for ZeroNet UserInterface and FileServer. However, the tracker will see all instances as one peer, as they all use one and the same external IP address. But you try it and explain your user case.
 - A solution that hasn't been confirmed yet is to use Tor instead. Each instance should then have a unique external address.
 
-## Documentation
-
- * Official documentation: https://zeronet.io/docs/site_development/getting_started/
- * YunoHost documentation: If specific documentation is needed, feel free to contribute.
-
-## YunoHost specific features
-
-#### Multi-user support
-
-Are LDAP and HTTP auth supported? No
-
-#### Android app (Still in beta)
-
-[Android app](https://github.com/canewsin/zeronet_mobile)
-
-#### Supported architectures
-
-* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/zeronet%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/zeronet/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/zeronet%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/zeronet/)
-
 ## Limitations
 
 * App can not be used inside SSO. See [here](https://github.com/HelloZeroNet/ZeroNet/issues/2541) and [here](https://github.com/YunoHost/issues/issues/1580).
 
-## Additional information
+## Documentation and resources
 
-* Other info you would like to add about this Zeronet.
+* Official app website: <https://zeronet.io>
-
+* Official admin documentation: <https://zeronet.io/docs/>
-**More info on the documentation page:**
+* Upstream app code repository: <https://github.com/HelloZeroNet/ZeroNet>
-https://yunohost.org/packaging_apps
+* YunoHost documentation for this app: <https://yunohost.org/app_zeronet>
-
+* Report a bug: <https://github.com/YunoHost-Apps/zeronet_ynh/issues>
-
-## Links
-
- * Report a bug: https://github.com/YunoHost-Apps/zeronet_ynh/issues
- * App website: https://zeronet.io/
- * Upstream app repository: https://github.com/HelloZeroNet/ZeroNet
- * YunoHost website: https://yunohost.org/
-
----
 
 ## Developer info
 
 Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/zeronet_ynh/tree/testing).
 
 To try the testing branch, please proceed like that.
-```
+
+``` bash
 sudo yunohost app install https://github.com/YunoHost-Apps/zeronet_ynh/tree/testing --debug
 or
 sudo yunohost app upgrade zeronet -u https://github.com/YunoHost-Apps/zeronet_ynh/tree/testing --debug
 ```
+
+**More info regarding app packaging:** <https://yunohost.org/packaging_apps>

README_fr.md

@@ -0,0 +1,61 @@
+<!--
+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.
+-->
+
+# ZeroNet pour YunoHost
+
+[![Niveau d'intégration](https://dash.yunohost.org/integration/zeronet.svg)](https://dash.yunohost.org/appci/app/zeronet) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/zeronet.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/zeronet.maintain.svg)  
+[![Installer ZeroNet avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=zeronet)
+
+*[Read this readme in english.](./README.md)*
+
+> *Ce package vous permet d'installer ZeroNet 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
+
+ZeroNet allows you to publish static and dynamic websites on a distributed web platform using Bitcoin crypto and the BitTorrent network.
+
+
+**Version incluse :** 2021.01.25~ynh1
+
+## Captures d'écran
+
+![Capture d'écran de ZeroNet](./doc/screenshots/screenshot.png)
+
+## Avertissements / informations importantes
+
+## Install instructions
+- This app can only be installed on root path, i.e you will need to use a dedicated domain name, e.g.`zeronet.domain.tld`.
+- You can setup Tor which has to be done manually till its implimented in the app.[how to use zeronet with Tor](https://zeronet.readthedocs.io/en/latest/faq/#how-to-use-zeronet-with-tor)
+
+## Multiple Instances
+- Installing multiple instances of the app is *experimental*. Internally each instance will use an unique port for both for ZeroNet UserInterface and FileServer. However, the tracker will see all instances as one peer, as they all use one and the same external IP address. But you try it and explain your user case.
+- A solution that hasn't been confirmed yet is to use Tor instead. Each instance should then have a unique external address.
+
+## Limitations
+
+* App can not be used inside SSO. See [here](https://github.com/HelloZeroNet/ZeroNet/issues/2541) and [here](https://github.com/YunoHost/issues/issues/1580).
+
+## Documentations et ressources
+
+* Site officiel de l'app : <https://zeronet.io>
+* Documentation officielle de l'admin : <https://zeronet.io/docs/>
+* Dépôt de code officiel de l'app : <https://github.com/HelloZeroNet/ZeroNet>
+* Documentation YunoHost pour cette app : <https://yunohost.org/app_zeronet>
+* Signaler un bug : <https://github.com/YunoHost-Apps/zeronet_ynh/issues>
+
+## Informations pour les développeurs
+
+Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/zeronet_ynh/tree/testing).
+
+Pour essayer la branche testing, procédez comme suit.
+
+``` bash
+sudo yunohost app install https://github.com/YunoHost-Apps/zeronet_ynh/tree/testing --debug
+ou
+sudo yunohost app upgrade zeronet -u https://github.com/YunoHost-Apps/zeronet_ynh/tree/testing --debug
+```
+
+**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps>