From ff4c21a74715177615c0ff078868804bd8767f8b Mon Sep 17 00:00:00 2001 From: Alex Orid Date: Wed, 23 Sep 2020 03:03:18 -0400 Subject: [PATCH] Updated Readme --- README.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e45dfc0..9406164 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,15 @@ -A chatbot to help with live stream production/effects. +A chatbot to help with live stream production and effects. ___ -# Credentials Setup: +# Credentials: -Create a json based on the templates and put them into the credentials folder. +## Credentials Setup: -## For Twitch Credentials +Create a json based on the templates and put them into the `/credentials/` folder. +Refer to the `/credential_templates/` folder for examples. + +### For Twitch Credentials Username = `TwitchUsername` Helix Client ID = `https://dev.twitch.tv/console/apps` @@ -15,5 +18,12 @@ Oauth = `https://twitchapps.com/tmi/` V5 Client ID = `https://twitchtokengenerator.com/` -## For Database Credentials +### For Database Credentials Engine = `"mysql+mysqlconnector://root:password@localhost:3306/DatabaseName"` + +## Credential Usage: + +Place json credentials in the `/credentials/` folder. +To load them, run `load_credentials()` from `Credentials_Module` in the `credentials.py` script. + +___ \ No newline at end of file