From ea1a4a4b83d3a55c3fe8099a99a773cefb519bb8 Mon Sep 17 00:00:00 2001 From: Alex Orid Date: Thu, 13 May 2021 15:20:04 -0400 Subject: [PATCH] updated readme --- README.md | 31 +++++++++++++++++-------------- praxis-user.bat | 2 -- 2 files changed, 17 insertions(+), 16 deletions(-) delete mode 100644 praxis-user.bat diff --git a/README.md b/README.md index 93003a5..66c0a34 100644 --- a/README.md +++ b/README.md @@ -2,29 +2,32 @@ An evolving chatbot to help users primarily with live stream production and effe ___ -# Standalone V2 Info +# Praxis Bot ## Docker: +This bot primarily uses docker to run various services. ### Image Setup: -Use these commands to build the images.
-`docker build --file Dockerfile_standalone_command --tag standalone_command .`
-`docker build --file Dockerfile_standalone_channelRewards --tag standalone_channelrewards .`
-`docker build --file Dockerfile_standalone_lights --tag standalone_lights .`
-`docker build --file Dockerfile_standalone_DiscordScript --tag standalone_discordscript .`
-`docker build --file Dockerfile_standalone_TwitchScript --tag standalone_twitchscript .`
-`docker build --file Dockerfile_standalone_Twitch_Pubsub --tag standalone_twitch_pubsub .`
+Use the following command to setup all the images. + +Windows: `makedockerimages.bat`
+Linux: `makedockerimages.sh` + ### Docker-Compose Info: To Start: -`docker-compose up -d`
+`docker-compose up -d`
To Stop: -`docker-compose down`
-
+`docker-compose down`
+
___ +# Docker: + + +___ # Credentials: ## Credentials Setup: @@ -32,7 +35,7 @@ ___ 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 +## For Twitch Credentials: Username = `TwitchUsername` *(Must match ***credentialsNickname*** in config)* Helix Client ID = `https://dev.twitch.tv/console/apps` @@ -41,12 +44,12 @@ Oauth = `https://twitchapps.com/tmi/` V5 Client ID = `https://twitchtokengenerator.com/` -### For Database Credentials +## For Database Credentials: Nickname = `Anything You Want` *(Must match ***credentialsNickname*** in config)* Engine = `"mysql+mysqlconnector://root:password@localhost:3306/DatabaseName"` -### For Discord Credentials +## For Discord Credentials: Nickname = `Anything You Want` *(Must match ***credentialsNickname*** in config)* Token = `https://discord.com/developers/` diff --git a/praxis-user.bat b/praxis-user.bat deleted file mode 100644 index c56d4a6..0000000 --- a/praxis-user.bat +++ /dev/null @@ -1,2 +0,0 @@ -cd "c:\praxis" -python "c:\praxis\standalone_user_cli.py" \ No newline at end of file