update status and add details to readme

master
mutantmonkey 2012-06-01 21:46:40 -07:00
parent 3f63f7992f
commit 28cde318a8
1 changed files with 8 additions and 6 deletions

View File

@ -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
-------