From 8dacaed9babce8639a45354bd31df2e6f81fba3e Mon Sep 17 00:00:00 2001
From: Kay0u <pierre@kayou.io>
Date: Mon, 7 Feb 2022 14:14:25 +0100
Subject: [PATCH] add auto readme

---
 doc/DISCLAIMER _fr.md | 29 +++++++++++++++++++++++++++++
 doc/DISCLAIMER.md     | 32 ++++++++++++++++++++++++++++++++
 manifest.json         | 16 ++++++++++++++--
 3 files changed, 75 insertions(+), 2 deletions(-)
 create mode 100644 doc/DISCLAIMER _fr.md
 create mode 100644 doc/DISCLAIMER.md

diff --git a/doc/DISCLAIMER _fr.md b/doc/DISCLAIMER _fr.md
new file mode 100644
index 0000000..d941853
--- /dev/null
+++ b/doc/DISCLAIMER _fr.md	
@@ -0,0 +1,29 @@
+## Configuration
+
+Comment configurer cette application: via le panneau d'administration.
+
+#### Support multi-utilisateurs
+
+ * L'authentification LDAP et HTTP est-elle prise en charge? **Oui**
+ * L'application peut-elle être utilisée par plusieurs utilisateurs? **Oui**
+
+## Migration depuis SPIP2
+
+**Ceci n'est pas encore considéré comme stable, veuillez le faire avec soin et uniquement pour test!**
+
+Ce paquet gère la migration de SPIP2 vers SPIP. Pour cela, votre application SPIP2 doit être **à jour** dans YunoHost. Pour s'en assurer :
+
+```bash
+sudo yunohost app upgrade -u https://github.com/YunoHost-Apps/spip2_ynh spip2 --debug
+```
+
+Vous devrez ensuite mettre à jour votre application SPIP2 avec ce dépôt.
+Cela ne peut se faire qu'à partir de l'interface en ligne de commande - par exemple via SSH. Une fois connecté, il vous suffit d'exécuter ce qui suit :
+
+```bash
+sudo yunohost app upgrade -u https://github.com/YunoHost-Apps/spip_ynh spip2 --debug
+```
+
+L'option `--debug` vous permettra de voir la sortie complète. Si vous rencontrez un problème, veuillez ouvrir une issue.
+
+Notez qu'une tâche cron sera exécutée après la fin de cette commande. Vous devez attendre cela avant de faire toute autre opération d'application ! Vous devriez voir que SPIP est installé après cela.
diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md
new file mode 100644
index 0000000..885edd8
--- /dev/null
+++ b/doc/DISCLAIMER.md
@@ -0,0 +1,32 @@
+## Configuration
+
+How to configure this app: by an admin panel.
+
+#### Multi-users support
+
+ * Are LDAP and HTTP auth supported? **Yes**
+ * Can the app be used by multiple users? **Yes**
+
+## Migrate from SPIP2
+
+**This is not considered as stable yet, please do it with care and only for testing!**
+
+This package handle the migration from SPIP2 to SPIP. For that, your
+SPIP2 application must be **up-to-date** in YunoHost. To ensure that, execute:
+
+```bash
+sudo yunohost app upgrade -u https://github.com/YunoHost-Apps/spip2_ynh spip2 --debug
+```
+
+You will then have to upgrade your SPIP2 application with this repository.
+This can only be done from the command-line interface - e.g. through SSH. Once you're connected, you simply have to execute the following:
+
+```bash
+sudo yunohost app upgrade -u https://github.com/YunoHost-Apps/spip_ynh spip2 --debug
+```
+
+The `--debug` option will let you see the full output. If you encounter any issue, please paste it.
+
+Note that a cron job will be executed at some time after the end of this
+command. You must wait that before doing any other application operations!
+You should see that SPIP is installed after that.
diff --git a/manifest.json b/manifest.json
index 6fd563c..281d225 100644
--- a/manifest.json
+++ b/manifest.json
@@ -8,6 +8,14 @@
     },
     "version": "4.0.1~ynh1",
     "url": "http://www.spip.net/",
+    "upstream": {
+        "license": "GPL-3.0-or-later",
+        "website": "http://www.spip.net/",
+        "demo": "https://demo.spip.net/",
+        "admindoc": "https://www.spip.net/en_rubrique209.html",
+        "userdoc": "https://www.spip.net/en_rubrique57.html",
+        "code": "https://git.spip.net/spip/spip"
+    },
     "license": "GPL-3.0-or-later",
     "maintainer": {
         "name": "cyp",
@@ -22,7 +30,7 @@
         "mysql"
     ],
     "arguments": {
-        "install" : [
+        "install": [
             {
                 "name": "domain",
                 "type": "domain"
@@ -53,7 +61,11 @@
                     "en": "Choose the status of YunoHost users",
                     "fr": "Choisissez le status des utilisateurs de YunoHost"
                 },
-                "choices": ["Administrator", "Editor", "Visitor"],
+                "choices": [
+                    "Administrator",
+                    "Editor",
+                    "Visitor"
+                ],
                 "default": "Editor"
             }
         ]