From 382878b7d2a4b98d346a5e5df30b638f23a92ab6 Mon Sep 17 00:00:00 2001 From: kongr45gpen Date: Tue, 23 Jul 2013 23:49:47 +0300 Subject: Populate the README.md a bit --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index d60b47a..a5bde8a 100644 --- a/README.md +++ b/README.md @@ -1 +1,17 @@ -Insert a description of your plugin here, with any notes, etc. about using it. +***supybot-github*** is a plugin for the python-based IRC bot Supybot. + +Its purpose is to announce commits and other important notifications from +a Github repository on an IRC channel, using Github's post commit hooks. + +Please note that I am a complete beginner as far as Python and supybot plugins +are concerned, which means that you should expect bad-looking code which does +not meet any standards. I would be happy to accept any pull request to fix +my bad python coding style. + +Getting started +============== +**Installation instructions to be put here...** + +Todo +==== +* Add a list of things to do on the issue tracker -- cgit v1.2.3