From 3292ead034b9677f5440857371298302e2ea1c4e Mon Sep 17 00:00:00 2001 From: James Lu Date: Thu, 24 Dec 2015 19:52:33 -0800 Subject: [PATCH] README: formatting and minor content update --- README.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index b6e48c1..4d0ff57 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,33 @@ # PyLink -PyLink is an extensible, plugin-based IRC Services framework written in Python. It aims to be 1) a replacement for the now-defunct Janus 2) a versatile framework and gateway to IRC. +PyLink is an extensible, plugin-based IRC services framework written in Python. It aims to be: -## Usage +1) a replacement for the now-defunct Janus. + +2) a versatile framework and gateway to IRC. + +## Support **PyLink is a work in progress and thus may be very unstable**! No warranty is provided if this completely wrecks your network and causes widespread rioting amongst your users! -That said, please report any bugs you find to the [issue tracker](https://github.com/GLolol/PyLink/issues). Pull requests are open if you'd like to contribute: note that **master** is bugfix only; new stuff goes to the **devel** branch. +That said, please report any bugs you find to the [issue tracker](https://github.com/GLolol/PyLink/issues). Pull requests are open if you'd like to contribute, though new stuff generally goes to the **devel** branch. -You can also find support via our IRC channel: `#PyLink at irc.overdrivenetworks.com` ([webchat](https://webchat.overdrivenetworks.com/?channels=PyLink,dev)). Ask your question and be patient. +You can also find support via our IRC channel: `#PyLink at irc.overdrivenetworks.com` ([webchat](https://webchat.overdrivenetworks.com/?channels=PyLink,dev)). Ask your questions and be patient for a response. -### Dependencies - -Dependencies currently include: +## Dependencies * Python 3.4+ * PyYAML (`pip install pyyaml` or `apt-get install python3-yaml`) -* *For the relay plugin only*: expiringdict (`pip install expiringdict`/`apt-get install python3-expiringdict`) +* *For the relay plugin*: expiringdict (`pip install expiringdict`/`apt-get install python3-expiringdict`) -#### Supported IRCds +### Supported IRCds * InspIRCd 2.0.x - module `inspircd` * charybdis (3.5.x / git master) - module `ts6` * Elemental-IRCd (6.6.x / git master) - module `ts6` * UnrealIRCd 4.x (**experimental**) - module `unreal` (*NOT* Unreal 3.2 or lower) -### Setup +## Setup 1) Rename `config.yml.example` to `config.yml` and configure your instance there. Note that the configuration format isn't finalized yet - this means that your configuration may break in an update!