Explorar el Código

Updated for new functionality, and setup and run instructions

allens hace 4 días
padre
commit
c12ec85981
Se han modificado 1 ficheros con 17 adiciones y 1 borrados
  1. 17 1
      README.md

+ 17 - 1
README.md

@@ -4,8 +4,24 @@ 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
+``` owncast_url = ''  # The URL of your Owncast server, with https://
+    logfile = ''  # /full/path/to/logfile.txt
     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. It's an integer, so no quotes.
 ```
+
+### Setup
+
+Create your venv, we'll call it ".venv", and activate it.
+
+```
+pip install --upgrade pip
+pip install .
+```
+
+### Run with:
+
+```
+.venv/bin/python nagbot.py
+```