Browse Source

Update 'README.md'

Added config.py instructions
deadtom 3 days ago
parent
commit
68edb3ccad
1 changed files with 9 additions and 1 deletions
  1. 9 1
      README.md

+ 9 - 1
README.md

@@ -1,3 +1,11 @@
 # Nagbot
 
-A bot for automagically sending messages to Owncast chat, at specified intervals.
+A bot for automagically sending messages to Owncast chat, at specified intervals.
+
+
+### Create a config.py
+``` api_url = ''  # The URL of your Owncast server's API
+    auth_bearer = ''  # The API authentication code for your Owncast server's API. 
+    nags = ['this is a message', 'this is another message']  # A list of messages to be cycled through
+    interval = '' # The interval, in seconds, between messages
+```