docs(hotreload): add docs
This commit is contained in:
parent
b22d81f514
commit
1993da084d
2 changed files with 38 additions and 8 deletions
22
.docs/hotreload.md
Normal file
22
.docs/hotreload.md
Normal file
|
@ -0,0 +1,22 @@
|
||||||
|
# HotReload
|
||||||
|
|
||||||
|
HotReload automatically reloads cogs in local cog paths on file change.
|
||||||
|
This is useful for development, as it allows you to make changes to your cogs and see the changes reflected in Discord immediately, without having to manually `[p]reload` the cog.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
```bash
|
||||||
|
[p]repo add seacogs https://www.coastalcommits.com/cswimr/SeaCogs
|
||||||
|
[p]cog install seacogs hotreload
|
||||||
|
[p]cog load hotreload
|
||||||
|
```
|
||||||
|
|
||||||
|
## Commands
|
||||||
|
|
||||||
|
### hotreload notifychannel
|
||||||
|
|
||||||
|
Set the channel where hotreload will send notifications when a cog is reloaded.
|
||||||
|
|
||||||
|
### hotreload list
|
||||||
|
|
||||||
|
Debugging command that shows the list of currently active observers. May be expanded in the future to show watched file paths.
|
|
@ -1,15 +1,23 @@
|
||||||
{
|
{
|
||||||
"author" : ["cswimr"],
|
"author": [
|
||||||
"install_msg" : "Thank you for installing HotReload! This cog does not provide any commands, please see the [documentation](https://seacogs.coastalcommits.com/hotreload) for more information.",
|
"cswimr"
|
||||||
"name" : "HotReload",
|
],
|
||||||
"short" : "Automatically reload cogs in local cog paths on file change.",
|
"install_msg": "Thank you for installing HotReload! Please see the [documentation](https://seacogs.coastalcommits.com/hotreload) to get started.",
|
||||||
"description" : "Automatically reload cogs in local cog paths on file change.",
|
"name": "HotReload",
|
||||||
"end_user_data_statement" : "This cog does not store end user data.",
|
"short": "Automatically reload cogs in local cog paths on file change.",
|
||||||
|
"description": "Automatically reload cogs in local cog paths on file change.",
|
||||||
|
"end_user_data_statement": "This cog does not store end user data.",
|
||||||
"hidden": false,
|
"hidden": false,
|
||||||
"disabled": false,
|
"disabled": false,
|
||||||
"min_bot_version": "3.5.0",
|
"min_bot_version": "3.5.0",
|
||||||
"min_python_version": [3, 10, 0],
|
"min_python_version": [
|
||||||
"requirements": ["watchdog"],
|
3,
|
||||||
|
10,
|
||||||
|
0
|
||||||
|
],
|
||||||
|
"requirements": [
|
||||||
|
"watchdog"
|
||||||
|
],
|
||||||
"tags": [
|
"tags": [
|
||||||
"utility",
|
"utility",
|
||||||
"development"
|
"development"
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue