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

clarify plugins

Browse Source
This commit is contained in:
Mallory Hancock 2017-10-02 11:30:14 -07:00
parent 7e66457968
commit 6904595052
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -51,7 +51,7 @@ 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:
The plugin function **must** return one of the following in order to give a response to the command:
* `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`)