From 4f01635b6991c14ea2b305030017b921601ca1b1 Mon Sep 17 00:00:00 2001 From: Xevion Date: Fri, 2 Feb 2024 11:45:48 -0600 Subject: [PATCH] Add .env notes to README --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 6c276e7..102a036 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,19 @@ A Discord bot for easily registering parking at the Register2Park parking system. +## Setup + +Environment variables are the preferred way of authenticating the bot's various connections. Place a `.env` file in the root of the project with the following variables: + +``` +BOT_TOKEN= +BOT_TARGET_GUILD= +REDIS_HOST= +REDIS_PASSWORD= +``` + +## Process + - Invoke the registration command on any location. - If a guest code is required, the bot will error and prompt for it. - If not required, or if invoked with a guest code, the bot will query R2P for the location's registration fields, such as make/model/plate/aptnum.