diff options
| author | Neel Kamath <neelkamath@protonmail.com> | 2018-05-13 12:33:22 +0200 |
|---|---|---|
| committer | Neel Kamath <neelkamath@protonmail.com> | 2018-05-13 12:33:22 +0200 |
| commit | 343157350f627b9495184246a90033a1c41f1a2c (patch) | |
| tree | e8688471fbee2bdcd5834abcb559ea1694eecadf /DOCUMENTATION.md | |
| parent | Use the 'use strict' directive when needed (diff) | |
| download | hackchat-343157350f627b9495184246a90033a1c41f1a2c.tar.gz hackchat-343157350f627b9495184246a90033a1c41f1a2c.zip | |
Re-add module documentation
Diffstat (limited to '')
| -rw-r--r-- | DOCUMENTATION.md | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index c110188..1b797f3 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -16,6 +16,7 @@ The commands are to be sent through a websocket to the URL wss://hack.chat/chat- |`morestats`||Sends back the current server's stats to the calling client.| |`move`|`channel`|This will change the current channel to `channel`.| |`stats`||Sends back legacy server stats to the calling client. Use `morestats` when possible.| +|`help`|`category` or `command`|Gives documentation programmatically. If `category` (the permission level, such as `mod`) is sent, a list of commands available to that permission level will be sent back (as a `string` and not an `array`). This list only includes what is unique to that category and not every command a user with that permission level could perform. If `command` (e.g., `chat`) is sent, a description of the command will be sent back.| # `mod` |