doc utilisateur

README.md

@@ -1,3 +1,49 @@
-# Coucou  
+# EducBot
+Un petit bot d'educ pop pour Discord (WIP).
+Il permet de voir qui secoue les mains dans un salon vocal.
+
+
+## Utilisation
+### Insaller le bot dans le serveur discord
+Ce n’est pour l’instant pas forcemment facile…
+
+### Fonctionnement
+EducBot écoute tous les messages d’un serveur où il a été installé (comme tous les bots).
+Il réagira a des commandes messages commençants par `!`, et a des mots-clef.
+
+EducBot a pour objectif de recenser les utilisateurs souhaitant réagir.
+
+#### Les commandes
+EducBot répondra en toutes circonstances (sauf serveur cassé) aux commandes suivantes :
+- `!educpop-help` Listera ces commandes
+- `!educpop-enable` Commence la comptabilisation
+- `!educpop-disable` Stope la comptabilisation
+- `!educpop-reset` Remet à zéro les compteurs
+- `!educpop-pause` Pause la comptabilisation
+- `!educpop-resume` Reprend la comptabilisation
+- `!educpop-list` Liste les mots-clés qui sont comptabilisés
+
+Par exemple, taper `!educpop-list` dans un canal texte **où EducBot est activé**, lui fait dire :
+```
+Tapez simplement le mot-clé ci-dessous pour être comptabilisé. Tapez un - immédiatement suivi du mot-clé pour être retiré du compte : -oui par exemple !
+:thumbsup:oui : Je suis d’accord
+:thumbsdown:non : Je ne suis pas d’accord
+:raised_hand:parole : Je veux parler
+:raised_hands:réponse : Je veux répondre rapidement
+:octagonal_sign:suffit : On tourne en rond
+:hear_no_evil:écoute : On ne s’écoute pas
+:heart_eyes:love : J’adore
+:dab:dab : Dab
+```
+
+#### Les mots-clés
+Écrire seulement `oui` dans un canal texte **où EducBot est activé**, lui fait ajouter votre username dans la liste des gens d’accord.
+Écrire seulement `-oui` fait retirer ce nom.
+
+#### Visualisation
+Le bot fait un résumé de l’état des compteurs à chaque changement.
+Pour des raisons de visibilités, le message utilisateur et les anciens messages de résumé sont supprimés.
+
+#### Interface web
+Une interface web permet de suivre l’état des compteurs sans être secoué par un chat en folie.
 
-un petit bot d'educ pop pour Discord (WIP)