Merge branch 'develop' into dist/ubuntu/xenial/develop

README.md

@@ -0,0 +1,31 @@
+# rocket-send
+
+Simple script Bash permettant d'envoyer un message en ligne de commande sur un canal Rocket.Chat via l'API REST de celui ci.
+
+## Utilisation
+
+```
+Envoie un message sur un canal Rocket.Chat
+
+Usage: rocket-send -c [CHANNEL] -m [MESSAGE]
+
+Options:
+    -c, --channel   [Obligatoire] Nom du canal sur lequel envoyer le message
+    -m, --message   [Obligatoire] Message à envoyer
+    -s, --server    URL racine du serveur Rocket.Chat
+    -e, --emoji     Emoji à utiliser comme avatar pour le message
+    -n, --nickname  Pseudonyme à utiliser pour le message
+    --config-dir    Chemin vers le répertoire de configuration, par défaut $HOME/.config/rocket-send
+    -h, --help      Afficher l'aide
+```
+
+## Configuration
+
+L'envoie d'un message sur un Rocket.Chat nécessite l'utilisation d'un compte utilisateur. Les identifiants utilisés par la commande `rocket-send` doivent être placé par défaut dans le fichier `$HOME/.config/rocket-send/config`.
+
+Le fichier doit au minimum présenter les variables de configuration suivantes:
+
+```shell
+RC_LOGIN=<identifiant>
+RC_PASSWORD=<mot de passe>
+```