3
0
mirror of https://github.com/jlu5/PyLink.git synced 2024-12-25 20:22:45 +01:00
PyLink/README.md
James Lu a5d71ffb56 README: mark TS6 support as experimental
Currently, #71 makes this near unusable because of mode flooding whenever anything happens on a slightly large network.
2015-07-24 10:56:23 -07:00

30 lines
1.0 KiB
Markdown

# PyLink
PyLink is an extensible, plugin-based IRC PseudoService written in Python. It aims to be a replacement for the now-defunct Janus.
## Usage
**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 throughout your user base!
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.
### Dependencies
Dependencies currently include:
* Python 3.4+
* PyYAML (`pip install pyyaml` or `apt-get install python3-yaml`)
#### Supported IRCds
* InspIRCd 2.0.x - module: `inspircd`
* charybdis (3.5.x / git master) - module: `ts6` (**experimental**)
### Installation
1) Rename `config.yml.example` to `config.yml` and configure your instance there. Not all options are properly implemented yet, and the configuration schema isn't finalized yet - this means your configuration may break in an update!
2) Run `main.py` from the command line.
3) Profit???