diff options
author | kongr45gpen <kongr45gpen@helit.org> | 2013-07-23 23:49:47 +0300 |
---|---|---|
committer | kongr45gpen <kongr45gpen@helit.org> | 2013-07-23 23:49:47 +0300 |
commit | 382878b7d2a4b98d346a5e5df30b638f23a92ab6 (patch) | |
tree | 9c81e1780ad6f4c8118b155817927939d34b3631 /README.md | |
parent | 210fc213c69e4c77334863a4fb068c072dc77c98 (diff) | |
download | supybot_github-382878b7d2a4b98d346a5e5df30b638f23a92ab6.tar.gz supybot_github-382878b7d2a4b98d346a5e5df30b638f23a92ab6.tar.bz2 supybot_github-382878b7d2a4b98d346a5e5df30b638f23a92ab6.zip |
Populate the README.md a bit
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 18 |
1 files changed, 17 insertions, 1 deletions
@@ -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 |