GitHub/PyLink
3
0
Fork 0
mirror of https://github.com/jlu5/PyLink.git synced 2024-12-24 03:33:10 +01:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
James Lu 2015-07-15 14:41:11 -07:00
parent 2106b8da3a
commit c22c187717
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -1,20 +1,24 @@
# PyLink
<img src="https://dl.dropboxusercontent.com/u/18664770/pylink.png" width="75%" height="75%">
PyLink is an extensible, plugin-based IRC PseudoService written in Python. It aims to be a replacement for the now-defunct Janus.
PyLink is an IRC PseudoService written in Python.
## Usage
## Dependencies
**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!
PyLink is a serious WIP right now. Dependencies currently include:
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:
* InspIRCd 2.0.x: more protocol modules may be implemented in the future...
* Python 3.4+
* PyYAML (`pip install pyyaml` or `apt-get install python3-yaml`)
## Usage
### 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.
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.