Update documentation

doc/DESCRIPTION.md

@@ -1,9 +1,11 @@
-Some long and extensive description of what the app is and does, lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+Pytition is an application for privacy-friendly online petitions you can host on your own server.
 
 ### Features
 
-- Ut enim ad minim veniam, quis nostrud exercitation ullamco ;
+- Host petitions without compromising the privacy of your signatories.
-- Laboris nisi ut aliquip ex ea commodo consequat ;
+- No tracking, ever: CSS, JS and all resources are self-hosted. Pytition does not use CDN.
-- Duis aute irure dolor in reprehenderit in voluptate ;
+- Responsive UI: works well on phones/tablets/laptops/desktops.
-- Velit esse cillum dolore eu fugiat nulla pariatur ;
+- Multi-lingual UI with i18n: English, French, Italian, Occitan, Spanish.
-- Excepteur sint occaecat cupidatat non proident, sunt in culpa."
+- You can pre-visualize petitions before publishing them.
+- Easy to use: petition content is typed-in via TinyMCE editors (like WordPress).
+- You can export signatures in CSV format.

doc/DESCRIPTION_fr.md

@@ -0,0 +1,11 @@
+Pytition permet d'héberger des pétitions respectueuses de la vie privée sur votre propre serveur.
+
+### Features
+
+- Hébergez des pétitions sans compromettre l'identité de vos signataires
+- Pas de tracking : CSS, JS et autres ressources sont auto-hébergées. Pas d'usage de CDN.
+- Interface réactive : fonctione sur smartphones et tablettes autant que sur ordinateur.
+- Interface traduite : anglais, français, italien, occitan, espagnol.
+- Vous pouvez prévisualiser les pétitions avant publication.
+- Simple à utiliser grâce à des éditeurs TinyMCE (comme Wordpress)
+- Vous pouvez exporter les signatures via CSV.

doc/DISCLAIMER.md

@@ -1,12 +1 @@
-* Any known limitations, constrains or stuff not working, such as (but not limited to):
+* No Single-Sign-On and Yunohost LDAP support
-    * requiring a full dedicated domain ?
-    * architectures not supported ?
-    * not-working single-sign on or LDAP integration ?
-    * the app requires an important amount of RAM / disk / .. to install or to work properly
-    * etc...
-
-* Other infos that people should be aware of, such as:
-    * any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
-    * how to configure / administrate the application if it ain't obvious
-    * upgrade process / specificities / things to be aware of ?
-    * security considerations ?

doc/DISCLAIMER_fr.md

@@ -0,0 +1 @@
+* Pas de support du Single-Sign-On ou du LDAP Yunohost.

manifest.json

@@ -1,25 +1,25 @@
 {
-    "name": "Example app",
+    "name": "Pytition",
-    "id": "example",
+    "id": "pytition",
     "packaging_format": 1,
     "description": {
-        "en": "Explain in *a few (10~15) words* the purpose of the app or what it actually does (it is meant to give a rough idea to users browsing a catalog of 100+ apps)",
+        "en": "Host privacy-friendly online petitions",
-        "fr": "Expliquez en *quelques* (10~15) mots l'utilité de l'app ou ce qu'elle fait (l'objectif est de donner une idée grossière pour des utilisateurs qui naviguent dans un catalogue de 100+ apps)"
+        "fr": "Hébergez des pétitions en ligne respectueuses de la vie privée"
     },
-    "version": "1.0~ynh1",
+    "version": "2.4~ynh1",
     "url": "https://example.com",
     "upstream": {
-        "license": "free",
+        "license": "BSD-3",
-        "website": "https://example.com",
+        "website": "https://github.com/pytition/Pytition",
-        "demo": "https://demo.example.com",
+        "demo": "https://demo.pytition.org",
-        "admindoc": "https://yunohost.org/packaging_apps",
+        "admindoc": "https://pytition.readthedocs.io/en/latest/",
-        "userdoc": "https://yunohost.org/apps",
+        "userdoc": "",
-        "code": "https://some.forge.com/example/example"
+        "code": "https://github.com/pytition/Pytition"
     },
-    "license": "free",
+    "license": "BSD-3",
     "maintainer": {
-        "name": "John doe",
+        "name": "Salamandar",
-        "email": "john.doe@example.com"
+        "email": "felix@piedallu.me"
     },
     "requirements": {
         "yunohost": ">= 4.3.0"
@@ -27,7 +27,6 @@
     "multi_instance": true,
     "services": [
         "nginx",
-        "php7.3-fpm",
         "mysql"
     ],
     "arguments": {
@@ -39,8 +38,8 @@
             {
                 "name": "path",
                 "type": "path",
-                "example": "/example",
+                "example": "/pytition",
-                "default": "/example"
+                "default": "/pytition"
             },
             {
                 "name": "is_public",
@@ -57,16 +56,12 @@
                 "choices": ["fr", "en"],
                 "default": "fr"
             },
-            {
-                "name": "admin",
-                "type": "user"
-            },
             {
                 "name": "password",
                 "type": "password",
                 "help": {
-                    "en": "Use the help field to add an information for the admin about this question.",
+                    "en": "Administrator password (username is admin)",
-                    "fr": "Utilisez le champ aide pour ajouter une information à l'intention de l'administrateur à propos de cette question."
+                    "fr": "Mot de passe administrateur (l'identifiant est admin)"
                 }
             }
         ]