Add better instructions to the Gitter example

gunthercox · Oct 21, 2018 · 7b6838e · 7b6838e
1 parent ebaceed
commit 7b6838e
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/examples/gitter_example.py b/examples/gitter_example.py
@@ -9,6 +9,17 @@
 # logging.basicConfig(level=logging.INFO)
 
 
+'''
+To use this example, create a new file called settings.py.
+In settings.py define the following:
+
+GITTER = {
+    "API_TOKEN": "my-api-token",
+    "ROOM": "example_project/test_room"
+}
+'''
+
+
 chatbot = ChatBot(
     'GitterBot',
     gitter_room=GITTER['ROOM'],