Documentation

README.md

@@ -5,7 +5,7 @@
 - [DONE] Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts, and any relevant conf files in `conf/`.
   - Using the [script helpers documentation.](https://yunohost.org/packaging_apps_helpers)
 - [DONE] Add a `LICENSE` file for the package.
-- [TODO] Ensure the configuration can be overridden
+- [DONE] Ensure the configuration can be overridden
 - [TODO] Edit `doc/DISCLAIMER*.md`
 - [TODO] The `README.md` files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
 
@@ -76,4 +76,3 @@ sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_yn
 ```
 
 **More info regarding app packaging:** https://yunohost.org/packaging_apps
-

doc/DESCRIPTION.md

@@ -1,9 +1,23 @@
-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.
+This is a discord puppeting bridge for matrix. It handles bridging private and group DMs, as well as Guilds (servers). It is based on [mx-puppet-bridge](https://github.com/Sorunome/mx-puppet-bridge).
 
 ### Features
 
-- Ut enim ad minim veniam, quis nostrud exercitation ullamco ;
+- Direct (1:1) Chats
-- Laboris nisi ut aliquip ex ea commodo consequat ;
+- DM Group Chats
-- Duis aute irure dolor in reprehenderit in voluptate ;
+- Plain Text
-- Velit esse cillum dolore eu fugiat nulla pariatur ;
+- Formatted Messages
-- Excepteur sint occaecat cupidatat non proident, sunt in culpa."
+- Media/files
+- Redactions/Deletions
+- Presence (Discord → Matrix only)
+- Typing notifications (Discord → Matrix only)
+- Replies
+- Edits
+- Reactions
+- Stickers
+- Multi-user
+- Friends management
+- Initiate chats from matrix
+
+### How to
+
+See <https://github.com/matrix-discord/mx-puppet-discord> for documentation.

doc/DESCRIPTION_fr.md

@@ -0,0 +1,23 @@
+Ceci est une passerelle vers Discord pour Matrix. Il gère la messagerie privée ou en groupe, tout comme la discussion dans une guilde (serveur Discord). Le projet est basé sur [mx-puppet-bridge](https://github.com/Sorunome/mx-puppet-bridge).
+
+### Fonctionnalités
+
+- Messagerie directe (1:1)
+- Discussion privée en groupe
+- Plein texte
+- Messages formattés
+- Fichiers / médias
+- Notification de rédaction / suppression
+- Présence (Discord → Matrix seulement)
+- Notification de saisie (Discord → Matrix seulement)
+- Réponses
+- Modifications de messages
+- Réactions
+- Stickers
+- Multi-utilisateur·rices
+- Gestion des ami·es
+- initier des chats depuis matrix
+
+### Comment faire
+
+Voir la documentation sur <https://github.com/matrix-discord/mx-puppet-discord> (en anglais).

doc/DISCLAIMER.md

@@ -1,12 +1,3 @@
-* Any known limitations, constrains or stuff not working, such as (but not limited to):
+After the install is complete, start a chat with `@_discordpuppet_bot:yourserver.com`. When it joins, type `help` in the chat to see instructions.
-    * 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:
+You also may modify the `/etc/matrix-puppet-discord/user.config.yaml` file to customize some configuration (like permissions to use the bridge). Ensure then to restart the bridge (`systemctl restart matrix-puppet-discord`).
-    * 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,3 @@
+Après l'installation, lancer une conversation privée avec `@_discordpuppet_bot:yourserver.com`. Ensuite, entrer `help` dans le chat pour lire les instructions.
+
+Vous pouvez par ailleurs modifier le fichier `/etc/matrix-puppet-discord/user.config.yaml` pour personnaliser la configuration (notamment les permissions pour utiliser la passerelle). Redémarrez bien ensuite la passerelle pour que les modifications soient effectives (`systemctl restart matrix-puppet-discord`).

manifest.json

@@ -3,7 +3,7 @@
     "id": "matrix-puppet-discord",
     "packaging_format": 1,
     "description": {
-        "en": "A Discord bridge for Matrix/Synapse.",
+        "en": "A Discord puppeting bridge for Matrix/Synapse.",
         "fr": "Passerelle Discord pour Matrix/Synapse."
     },
     "version": "1.0~ynh1",