Adding reviews.md template / Started fleshing out setup.py to handle errbot plugins
[margebot.git] / README.md
index 4acd309..fa3a9d9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,9 @@
-_margebot_ -- I remind you about outstanding Gitlab merge requests
-
+Marge: I remind you about outstanding Gitlab merge requests
 
+Use: 
 
+* In Gitlab:
+    * For each repo you want Margebot to watch, add a Merge Request triggered webhook in the form https://your.webhook.host/margebot/room1,room2 for haing Mrbebot send reminders to rooms room1 and room2.
+* In Errbot:
+    * Update CHATROOM\_PRESENCE list in config.py so Margebot joins all the rooms you want it to join.