xevion/r2park
1
0
Fork 0
mirror of https://github.com/Xevion/r2park.git synced 2025-12-05 23:15:56 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add .env notes to README

Browse Source
This commit is contained in:
Xevion
2024-02-02 11:45:48 -06:00
parent e6da0d0fae
commit 4f01635b69
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -2,6 +2,19 @@
A Discord bot for easily registering parking at the Register2Park parking system. 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. - Invoke the registration command on any location.
- If a guest code is required, the bot will error and prompt for it. - 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. - 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.