archangelic
/
pinhook
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

expand on plugin section

pull/1/head
Mallory Hancock 2017-10-02 11:25:59 -07:00
parent c1fa1f8e37
commit 8630d4d0ff
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -51,6 +51,10 @@ Keyword arguments currently passed to the plugin:
* `nick`: the user who triggered the command
* `arg`: all the trailing text after the command. This is what you will use to get optional information for the command
The plugin function *must* return one of the following:
* `pinhook.plugin.message`: basic message in channel where command was triggered
* `pinhook.plugin.action`: CTCP action in the channel where command was triggered (basically like using `/me does a thing`)
## Examples
There are some basic examples in the `examples` directory in this repository.