From 28cde318a873c265ba6defe6e3f6561868366ddb Mon Sep 17 00:00:00 2001 From: mutantmonkey Date: Fri, 1 Jun 2012 21:46:40 -0700 Subject: [PATCH] update status and add details to readme --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 6918ea1..82dcc50 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,16 @@ phenny ====== -This is an experimental port of phenny, a Python IRC bot, to Python3. It is -currently fairly stable, but it has not been as well-tested as the original. +This is a port of phenny, a Python IRC bot, to Python3. It is currently fairly +stable, but it has not been as well-tested as the original. It was developed +for #vtluug on OFTC. -Support for IPv6 and SSL has been added. It appears that SSL support requires -Python 3.2. +New features include many new modules, IPv6 and TLS support (which requires +Python 3.2), and unit tests. Compatibility with existing phenny modules has been mostly retained, but they -will need to be updated to run on Python3 if they do not already. +will need to be updated to run on Python3 if they do not already. All of the +core modules have been ported. Installation ------------ @@ -21,7 +23,7 @@ Enjoy! Testing ------- You will need the Python3 versions of `python-nose` and `python-mock`. To run -the test, simply run `nosetests3`. +the tests, simply run `nosetests3`. Authors -------