Auto-update README

README.md

@@ -1,3 +1,8 @@
+<!--
+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 for YunoHost
 
 [![Integration level](https://dash.yunohost.org/integration/peertube.svg)](https://dash.yunohost.org/appci/app/peertube) ![](https://ci-apps.yunohost.org/ci/badges/peertube.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/peertube.maintain.svg)  
@@ -5,13 +10,22 @@
 
 *[Lire ce readme en français.](./README_fr.md)*
 
-> *This package allows you to install PeerTube quickly and simply on a YunoHost server.  
+> *This package allows you to install PeerTube 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
 
-### What is PeerTube?
+Video streaming platform using P2P directly in the web browser, connected to a federated network
-PeerTube is a federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser, using <a href="https://github.com/feross/webtorrent">WebTorrent</a>.
+
+**Shipped version:** 3.4.1~ynh1
+
+**Demo:** http://peertube.cpy.re
+
+## Screenshots
+
+![](./doc/screenshots/screenshot1.png)
+
+## Disclaimers / important information
 
 ### Why PeerTube?
 
@@ -25,61 +39,33 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t
 ### Why is that cool?
 Servers are run independently by different people and organizations. They can apply wildly different moderation policies, so you can find or make one that fits your taste perfectly.
 
-By watching a video, you help the hosting provider to broadcast it by becoming a broadcaster of the video yourself. Each instance doesn’t need much money to broadcast the videos of its users.
+By watching a video, you help the hosting provider to broadcast it by becoming a broadcaster of the video yourself. Each instance doesn't need much money to broadcast the videos of its users.
 
-**Shipped version:** 3.4.1
+* Any known limitations, constrains or stuff not working, such as (but not limited to):
-
+    * Require **dedicated domain** like **peertube.domain.tld**.
-## Important points to read before installing
+    * Admin username is: **root**.
-
+    * **Admin password and LDAP configuration** will be sent to the email address given at the time of the installation.
-1. Require **dedicated domain** like **peertube.domain.tld**.
+    * URL can not be changed once selected. Choose the domain wisely.
-1. Admin username is: **root**.
+    * You need more then **1 GB** of RAM. If you don't have it, please create a **swap memory**.
-1. **Admin password and LDAP configuration** will be sent to the email address given at the time of the installation.
-1. URL can not be changed once selected. Choose the domain wisely.
-1. You need more then **1 GB** of RAM. If you don't have it, please create a **swap memory**.
  
         $ dd if=/dev/zero of=/swapfile bs=1024 count=1048576
         $ mkswap /swapfile
         $ swapon /swapfile
         $ echo "/swapfile swap swap defaults 0 0" >> /etc/fstab
         
-1. This app is **multi-instance** (you can have more then one PeerTube instance running on a YunoHost server)
+    * This app is **multi-instance** (you can have more then one PeerTube instance running on a YunoHost server)
-1. **If you are hosted on OVH virtual machine or experiencing `gyp ERR! configure error`, please switch to [ovh_fix](https://github.com/YunoHost-Apps/peertube_ynh/tree/ovh_fix)**
+    * **If you are hosted on OVH virtual machine or experiencing `gyp ERR! configure error`, please switch to [ovh_fix](https://github.com/YunoHost-Apps/peertube_ynh/tree/ovh_fix)**
- 
+    * LDAP auth is supported, LDAP configuration will be sent to the email address given at the time of the installation.
-## Screenshots
+    * HTTP auth is not supported
 
-![](https://framablog.org/wp-content/uploads/2018/03/Framatube-au-lancement.png)
+## Documentation and resources
 
-## Demo
+* Official app website: https://joinpeertube.org/fr/
-
+* Official user documentation: https://yunohost.org/#/app_peertube
-Want to see in action?
+* Official admin documentation: https://docs.joinpeertube.org/
-
+* Upstream app code repository: https://github.com/Chocobozzz/PeerTube/
-   * [Here](http://peertube.cpy.re) are the list of instances ran by people around the world. Be a part of it.
+* YunoHost documentation for this app: https://yunohost.org/app_peertube
-
+* Report a bug: https://github.com/YunoHost-Apps/peertube_ynh/issues
-## Documentation
-
- * Official documentation: https://docs.joinpeertube.org/
- * YunoHost documentation: https://yunohost.org/#/app_peertube
-
-## YunoHost specific features
-
-#### Multi-user support
-
-* LDAP auth is supported, LDAP configuration will be sent to the email address given at the time of the installation.
-* HTTP auth is not supported
-
-#### Supported architectures
-
-* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/peertube.svg)](https://ci-apps.yunohost.org/ci/apps/peertube/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/peertube.svg)](https://ci-apps-arm.yunohost.org/ci/apps/peertube/)
-
-## Links
-
- * Report a bug: https://github.com/YunoHost-Apps/peertube_ynh/issues
- * App website: https://joinpeertube.org/fr/
- * Upstream app repository: https://github.com/Chocobozzz/PeerTube/
- * YunoHost website: https://yunohost.org/
-
----
 
 ## Developer info
 
@@ -91,3 +77,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/peertube_ynh/tree/tes
 or
 sudo yunohost app upgrade peertube -u https://github.com/YunoHost-Apps/peertube_ynh/tree/testing --debug
 ```
+
+**More info regarding app packaging:** https://yunohost.org/packaging_apps

README_fr.md

@@ -3,28 +3,43 @@
 [![Niveau d'intégration](https://dash.yunohost.org/integration/peertube.svg)](https://dash.yunohost.org/appci/app/peertube) ![](https://ci-apps.yunohost.org/ci/badges/peertube.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/peertube.maintain.svg)  
 [![Installer PeerTube avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=peertube)
 
-*[Read this readme in english.](./README.md)* 
+*[Read this readme in english.](./README.md)*
+*[Lire ce readme en français.](./README_fr.md)*
 
-> *Ce package vous permet d'installer PeerTube rapidement et simplement sur un serveur YunoHost.  
+> *Ce package vous permet d'installer PeerTube rapidement et simplement sur un serveur YunoHost.
-Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/#/install) pour apprendre comment l'installer.*
+Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
+
+## Vue d'ensemble
+
+Plateforme de diffusion vidéo par P2P directement dans le navigateur, et connectée à un réseau fédéralisé
+
+**Version incluse :** 3.4.1~ynh1
+
+**Démo :** http://peertube.cpy.re
+
+## Captures d'écran
+
+![](./doc/screenshots/screenshot1.png)
+
+## Avertissements / informations importantes
 
 ## Vue d'ensemble
 
 ### Qu'est-ce que PeerTube ?
 PeerTube est une plateforme de streaming vidéo fédérée (ActivityPub) utilisant P2P (BitTorrent) directement dans le navigateur Web, en utilisant <a href="https://github.com/feross/webtorrent"> WebTorrent </a>.
-### Why PeerTube?
+
+### Pourquoi PeerTube?
 
 Nous ne pouvons pas créer d'alternatives de streaming vidéo FOSS à YouTube, Dailymotion, Vimeo... avec un logiciel centralisé. Une organisation seule ne peut pas avoir assez d'argent pour payer la bande passante et le stockage vidéo de son serveur.
 Nous avons donc besoin d'un réseau décentralisé de serveurs « semant » des vidéos (comme [Hubzilla YunoHost](https://github.com/YunoHost-Apps/hubzilla_ynh), [Friendica YunoHost](https://github.com/YunoHost-Apps/friendica_ynh), [Mastodon YunoHost](https://github.com/YunoHost-Apps/mastodon_ynh)), [Diaspora](https://github.com/diaspora/diaspora) ([Diaspora YunoHost](https://github.com/YunoHost-Apps/diaspora_ynh)),[Funkwhale](https://funkwhale.audio) ([Funkwhale YunoHost](https://github.com/YunoHost-Apps/funkwhale_ynh)).
 Mais ce n'est pas suffisant car une vidéo pourrait devenir célèbre et surcharger le serveur. C'est la raison pour laquelle nous devons utiliser un protocole P2P pour limiter la charge du serveur. Grâce à [WebTorrent](https://github.com/feross/webtorrent), nous pouvons faire du P2P (donc BitTorrent) dans le navigateur Web, dès aujourd'hui.
 
 ### Pourquoi est-ce cool ?
+
 Les serveurs sont gérés indépendamment par différentes personnes et organisations. Ils peuvent appliquer des politiques de modération extrêmement différentes, afin que vous puissiez en trouver ou en créer une qui correspond parfaitement à vos goûts.
 
 En regardant une vidéo, vous aidez l'hébergeur à la diffuser en devenant vous-même un diffuseur de la vidéo. Chaque instance n'a pas besoin de beaucoup d'argent pour diffuser les vidéos de ses utilisateurs.
 
-**Version incluse :** 3.4.1
-
 ## Points importants à lire avant l'installation
 
 1. Nécessite un **domaine dédié** comme **peertube.domain.tld**.
@@ -42,19 +57,6 @@ En regardant une vidéo, vous aidez l'hébergeur à la diffuser en devenant vous
 1. Cette application est **multi-instance** (vous pouvez avoir plus d'une instance PeerTube en cours d'exécution sur un serveur YunoHost)
 1. **Si vous êtes hébergé sur une machine virtuelle OVH ou rencontrez `gyp ERR! configure error`, veuillez passer à [ovh_fix](https://github.com/YunoHost-Apps/peertube_ynh/tree/ovh_fix)**
 
-## Captures d'écran
-
-![](https://framablog.org/wp-content/uploads/2018/03/Framatube-au-lancement.png)
-
-## Démo
-
- * [Démo](http://peertube.cpy.re)
-
-## Documentation
-
- * Documentation officielle : https://docs.joinpeertube.org/
- * Documentation YunoHost : https://yunohost.org/#/app_peertube_fr
-
 ## Caractéristiques spécifiques YunoHost
 
 #### Support multi-utilisateur
@@ -62,19 +64,14 @@ En regardant une vidéo, vous aidez l'hébergeur à la diffuser en devenant vous
 * L'authentification LDAP est prise en charge, les instructions de configuration sont envoyées à l'adresse email indiquée au moment de l'installation
 * L'authentification HTTP n'est pas prise en charge
 
-#### Architectures supportées
+## Documentations et ressources
 
-* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/peertube.svg)](https://ci-apps.yunohost.org/ci/apps/peertube/)
+* Site officiel de l'app : https://joinpeertube.org/fr/
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/peertube.svg)](https://ci-apps-arm.yunohost.org/ci/apps/peertube/)
+* Documentation officielle utilisateur : https://yunohost.org/#/app_peertube
-
+* Documentation officielle de l'admin : https://docs.joinpeertube.org/
-## Liens
+* Dépôt de code officiel de l'app : https://github.com/Chocobozzz/PeerTube/
-
+* Documentation YunoHost pour cette app : https://yunohost.org/app_peertube
- * Signaler un bug : https://github.com/YunoHost-Apps/peertube_ynh/issues
+* Signaler un bug : https://github.com/YunoHost-Apps/peertube_ynh/issues
- * Site de l'application : https://joinpeertube.org/fr/
- * Dépôt de l'application principale : https://github.com/Chocobozzz/PeerTube/
- * Site web YunoHost : https://yunohost.org/
-
----
 
 ## Informations pour les développeurs
 
@@ -86,3 +83,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/peertube_ynh/tree/tes
 ou
 sudo yunohost app upgrade peertube -u https://github.com/YunoHost-Apps/peertube_ynh/tree/testing --debug
 ```
+
+**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps