add readme

This commit is contained in:
Ryan Hitchman 2010-08-22 17:17:46 -05:00
parent 0b11684197
commit 1f84e5ded7
1 changed files with 22 additions and 0 deletions

22
README.creole Normal file
View File

@ -0,0 +1,22 @@
= Skybot =
==Goals==
* simplicity
** little boilerplate
** minimal magic
* power
** multithreading
** automatic reloading
** extensibility
==Features==
* Multithreaded dispatch and the ability to connect to multiple networks at a time.
* Easy plugin development with automatic reloading and a simple hooking API.
==Requirements==
Skybot runs on Python 2.6. Many of the plugins require [[http://codespeak.net/lxml/|lxml]]. It is developed on Ubuntu 9.10 with Python 2.6.4.
==Documentation==
[[Plugins|Writing plugins]]
[[Config|Configuration]]