NgTech-LTD/HFCNotificator
2
0
Fork 0
mirror of https://github.com/GaMeNu/HFCNotificator.git synced 2024-11-16 15:24:51 +02:00
Code Issues Packages Projects Releases Wiki Activity

More command documentation

Browse Source
This commit is contained in:
GaMeNu 2023-10-23 09:31:24 +03:00
parent 0d7d25ed75
commit 10e50ad2b4
1 changed files with 16 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -15,15 +15,27 @@ Alternatively, you can DM the bot to receive alerts directly to your DMs!
Please do note that the bot instance listed here is hosted on a private machine, and may be a bit slow.
## Command documentation
### /about
#### /about
Get some info about the bot
### /register
#### /register
Run in a channel to register it to receive alerts
### /unregister
#### /unregister
Run in a registered channel to stop it from receiving alerts
### /latest \<time\> \<unit\> \[page\]
#### /latest \<time\> \<unit\> \[page\]
Get the latest alerts from up to a certain time back.
### Location commands
#### /locations add \<id\>
Register a location to receive alerts from
#### /locations remove \<id\>
Remove a location to receive alerts from
#### /locations clear \<id\>
Clear all registered locations (Get alerts from everywhere)
#### /locations list \[page\]
List all valid locations
#### /locations registered \[page\]
List all registered locations
## Self-hosting
### Requirements
#### Required PyPI packages (run each with `pip install`)