Skip to content

Commit bfc13d4

Browse files
committed
Added additional usage docs
1 parent f553375 commit bfc13d4

1 file changed

Lines changed: 10 additions & 8 deletions

File tree

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ An unofficial way to structure a discordPHP bot.
1010
* [Slash Commands](#slash-commands)
1111
* [Events](#events)
1212
* [Disabling Commands and Events](#disabling-commands-and-events)
13-
* [Hot Reloading](#hot-reloading)
13+
* [Extending The Template](#extending-the-template)
14+
* [Bootstrap Sequence](#bootstrap-sequence)
15+
* [Environment Variables](#environment-variables)
1416

1517
# Installation
1618

@@ -117,14 +119,14 @@ class Ready implements Init
117119
}
118120
```
119121

120-
# Hot Reloading
122+
# Extending The Template
121123

122-
This template has a built-in HMR (Hot Module Reloading) system.
123-
Which essentially means that while you're developing your
124-
bot.
124+
## Bootstrap Sequence
125125

126-
The code will automatically be updated without having to restart the bot.
127-
Set HMR in your `.env` file to `true` to enable it.
126+
Create a file inside `/Bootstrap` and then require it inside of `/Boostrap/Requires.php`.
128127

129-
**Note: HMR only works on Commands and Events. (~~for now~~)**
128+
## Environment Variables
130129

130+
Add a doc comment to `/Core/Env.php` and then add the variable to `.env`
131+
132+
*You should also add it to `.env.example`*

0 commit comments

Comments
 (0)