diff --git a/README.md b/README.md index 043d76a..505c398 100644 --- a/README.md +++ b/README.md @@ -5,34 +5,45 @@ HelBot v5 introduces an improved background logic structure, streamlined integra ### Database Structure: **client.credentials**: -- `_id` -- `client_id` -- `client_secret` -- `token` -- `service` -- `mod_id` +- `client_id` (twitch:discord) +- `client_secret` (twitch:discord) +- `token` (access_token:token) +- `service` (twitch:discord) +- `mod_id` (twitch only) **shoutouts.#channel**: -- `_id` - `user` - `created_at` **guilds.id**: -- `_id` -- `settings` -- `channels` +- `event` +- `channel` + +**commands.channel**: +- `name` +- `enabled` + +**settings.channel**: +- `name` +- `enabled` ### Chat Commands: **Update Chat Mode** (Mods & Broadcaster only) - `$mode [on:off]` -**Get a Random Positive Reminder** +**Get A Positive Reminder** - `$positivity` **View Donothon/Charity Event Information** - `$donate` +**View / Manage Settings** +- `$commands [enable:disable] [setting]` + +**View / Manage Commands** +- `$commands [enable:disable] [command]` + ### Behaviour: - Automatically protects the chat by enabling **follow-only**, **sub-only**, or **emote-only** modes when the stream goes offline.