update status and add details to readme
parent
3f63f7992f
commit
28cde318a8
14
README.md
14
README.md
|
@ -1,14 +1,16 @@
|
||||||
phenny
|
phenny
|
||||||
======
|
======
|
||||||
|
|
||||||
This is an experimental port of phenny, a Python IRC bot, to Python3. It is
|
This is a port of phenny, a Python IRC bot, to Python3. It is currently fairly
|
||||||
currently fairly stable, but it has not been as well-tested as the original.
|
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
|
New features include many new modules, IPv6 and TLS support (which requires
|
||||||
Python 3.2.
|
Python 3.2), and unit tests.
|
||||||
|
|
||||||
Compatibility with existing phenny modules has been mostly retained, but they
|
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
|
Installation
|
||||||
------------
|
------------
|
||||||
|
@ -21,7 +23,7 @@ Enjoy!
|
||||||
Testing
|
Testing
|
||||||
-------
|
-------
|
||||||
You will need the Python3 versions of `python-nose` and `python-mock`. To run
|
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
|
Authors
|
||||||
-------
|
-------
|
||||||
|
|
Loading…
Reference in New Issue