From 8630d4d0ff147aec8d1898ac5df9e96a49556f80 Mon Sep 17 00:00:00 2001 From: Mallory Hancock Date: Mon, 2 Oct 2017 11:25:59 -0700 Subject: [PATCH] expand on plugin section --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index aeb78d1..37f4771 100644 --- a/README.md +++ b/README.md @@ -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.