Apply example_ynh

1 files changed, 47 insertions, 43 deletions

diff --git a/README.md b/README.md
index c3cbc9a..1e277dd 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,13 @@
 # Mastodon for YunoHost
 
+[![Integration level](https://dash.yunohost.org/integration/mastodon.svg)](https://dash.yunohost.org/appci/app/mastodon)  
+[![Install mastodon with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=mastodon)
+
+*[Lire ce readme en français.](./README_fr.md)*
+
+> *This package allow you to install mastodon quickly and simply on a YunoHost server.  
+If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
+
 [![Latest Version](https://img.shields.io/badge/version-2.7.1-green.svg?style=flat)](https://github.com/YunoHost-Apps/mastodon_ynh/releases)
 [![Status](https://img.shields.io/badge/status-testing-yellow.svg?style=flat)](https://github.com/YunoHost-Apps/mastodon_ynh/milestones)
 [![Dependencies](https://img.shields.io/badge/dependencies-includes-lightgrey.svg?style=flat)](https://github.com/YunoHost-Apps/mastodon_ynh#dependencies)
@@ -7,59 +15,22 @@
 [![Yunohost version](https://img.shields.io/badge/yunohost-2.7.12_tested-orange.svg?style=flat)](https://github.com/YunoHost/yunohost)
 [![GitHub issues](https://img.shields.io/github/issues/YunoHost-Apps/mastodon_ynh.svg?style=flat)](https://github.com/YunoHost-Apps/mastodon_ynh/issues)
 
-[![Install Mastodon with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=mastodon)
-
-:warning: MAJ 05/06/17 :Cette application peut maintenant fonctionner sur ARM, mais l'installation prend plusieurs heures et il faut ajouter un swapfile de 1Go.
-
-:warning: Cette application utilise les packages backports de Debian, nous vous recommendons de ne pas installer cette application directement en production
-
 :warning: UPDATE 05/06/17 :This app can work now on ARM, but installation takes several hours and you must add a swapfile of 1GB.
 
 :warning: This application uses the Debian backports packages, do not install this application directly in production
 
-## Mastodon c'est quoi ?
-
-Mastodon est un réseau social gratuit et open source. Une alternative décentralisée aux plates-formes commerciales, elle évite les risques d'une seule société qui monopolise votre communication. Choisissez un serveur sur lequel vous faites confiance - selon votre choix, vous pouvez interagir avec tous les autres. N'importe qui peut exécuter sa propre instance de Mastodon et participer au réseau social de façon transparente.
-
-[Source code](https://github.com/tootsuite/mastodon)
-
-#### Ajout d'un "swapfile" si vous avez moins de 2Go de RAM
-```
-sudo dd if=/dev/zero of=/swapfile bs=1024 count=1024000
-sudo chmod 600 /swapfile
-sudo mkswap /swapfile
-sudo swapon /swapfile
-```
-ajouter cette ligne dans /etc/fstab
-```
-/swapfile       none    swap    sw      0       0
-```
-
-### Installation
+## Overview
 
-#### Utilisation de __screen__ en cas de déconnection
-```
-$ sudo apt-get install screen
-$ screen
-$ sudo yunohost app install https://github.com/YunoHost-Apps/mastodon_ynh.git
-```
-Récuperer l'installation après une deconnection:
-```
-$ screen -d
-$ screen -r
-```
-L'utilisateur admin est crée automatiquement comme: user@domain.tld
+**Shipped version:** 2.7.4
 
-### Mise à jour
-#### Utilisation de __screen__ fortement recommandé
+## Screenshots
 
-`$ sudo yunohost app upgrade --verbose mastodon -u https://github.com/YunoHost-Apps/mastodon_ynh.git`
+![](https://framalibre.org/sites/default/files/mastodon.png)
 
-## Recommandations
 
-Vous ne pouvez pas installer Mastodon en subdirectory, vous devez obligatoirement utiliser un domaine ou un sous-domaine pour cette application.
+[Source code](https://github.com/tootsuite/mastodon)
 
-Il semble important de fermer les inscriptions pour votre Mastodon, pour que ça reste une instance privé. Nous vous invitons à bloquer les instances distantes malfaisantes depuis l'interface d'administration. Vous pouvez également ajouter un texte sur votre page d'accueil dans l'administration.
+## Configuration
 
 ## What is Mastodon?
 
@@ -103,3 +74,36 @@ The admin user is automatically created as: user@domain.tld
 You can't install Mastodon in subdirectory, you must use a domain or subdomain for this application.
 
 It seems important to close the inscriptions for your Mastodon, so that it remains a private body. We invite you to block remote malicious instances from the administration interface. You can also add text on your home page.
+
+## Documentation
+
+ * Official documentation: https://docs.joinmastodon.org/
+
+## YunoHost specific features
+
+#### Supported architectures
+
+* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/mastodon%20%28Community%29.svg)](https://ci-apps.yunohost.org/ci/apps/mastodon/)
+* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/mastodon%20%28Community%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/mastodon/)
+* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/mastodon%20%28Community%29.svg)](https://ci-stretch.nohost.me/ci/apps/mastodon/)
+
+## Links
+
+ * Report a bug: https://github.com/YunoHost-Apps/mastodon_ynh/issues
+ * App website: Link to the official website of this app
+ * YunoHost website: https://yunohost.org/
+
+---
+
+Developers info
+----------------
+
+**Only if you want to use a testing branch for coding, instead of merging directly into master.**
+Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/mastodon_ynh/tree/testing).
+
+To try the testing branch, please proceed like that.
+```
+sudo yunohost app install https://github.com/YunoHost-Apps/mastodon_ynh/tree/testing --debug
+or
+sudo yunohost app upgrade mastodon -u https://github.com/YunoHost-Apps/mastodon_ynh/tree/testing --debug
+```