diff options
| author | neelkamath <neelkamath@protonmail.com> | 2018-05-12 10:22:19 +0200 |
|---|---|---|
| committer | neelkamath <neelkamath@protonmail.com> | 2018-05-12 10:22:19 +0200 |
| commit | 4b30736929e65ec7ad664b2ffb2d1eca10b0636a (patch) | |
| tree | e3416d949fb630245e0b6ad4729cc654fe624eb8 /DOCUMENTATION.md | |
| parent | Clarify documentation (diff) | |
| download | hackchat-4b30736929e65ec7ad664b2ffb2d1eca10b0636a.tar.gz hackchat-4b30736929e65ec7ad664b2ffb2d1eca10b0636a.zip | |
Remove help.js as we need human, not programmatic documentation for this
Diffstat (limited to 'DOCUMENTATION.md')
| -rw-r--r-- | DOCUMENTATION.md | 1 |
1 files changed, 0 insertions, 1 deletions
diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index 97d46b8..eaf3303 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -11,7 +11,6 @@ The commands are to be sent through a websocket to the URL wss://hack.chat/chat- |`changenick`|`nick`|Changes the current connection's nickname.| |`chat`|`text`|This broadcasts `text` to the channel the user is connected to.| |`disconnect`||An event handler or forced disconnect.| -|`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`), a description of the command will be sent back.| |`invite`|`nick`|Generates a pseudo-unique channel name and passes it to both the calling user and `nick`.| |`join`|`channel`, `nick`|Places the calling socket into the target channel with the target nick and broadcasts the event to the channel.| |`morestats`||Sends back the current server's stats to the calling client.| |