From 1f84e5ded7251c7614ce65d9cbbcb290d1fff89c Mon Sep 17 00:00:00 2001 From: Ryan Hitchman Date: Sun, 22 Aug 2010 17:17:46 -0500 Subject: [PATCH] add readme --- README.creole | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 README.creole diff --git a/README.creole b/README.creole new file mode 100644 index 0000000..b85b738 --- /dev/null +++ b/README.creole @@ -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]]