added default creds file to make setting it up more intuitive

0xjmux · Mar 3, 2022 · 7177674 · 7177674
1 parent e323694
commit 7177674
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -4,6 +4,11 @@ Discord bot to alert people in the IEEE UCI Discord when the room is open
 ### Usage
 Flip switch "On" to send a discord message alerting people the room is open. Flip switch "Off" to send a message alerting people that the room is closed. 
 
+### Installation & Configuration
+* Extract & Install on pi. Install `requests` library through pip.
+* You need to rename `creds_CHANGEME.py` to `_creds_.py` and add your discord webhook to the `WEBHOOK_URL` field in the file. 
+
+
 
 ### Indicator Light Behavior
 * When operating correctly, only one light should be on at a time. The lights will ONLY change once a message has successfully been posted to discord.

diff --git a/creds_CHANGEME.py b/creds_CHANGEME.py
@@ -0,0 +1,6 @@
+#!/usr/bin/env python3
+
+# This is the default credential file in the github repo. 
+# you need to rename this file to "_creds_.py" and then add your discord webhook URL below.
+
+WEBHOOK_URL = ""