GitHub/PyLink
3
0
Fork 0
mirror of https://github.com/jlu5/PyLink.git synced 2024-12-28 05:32:51 +01:00
Code Issues Projects Releases Wiki Activity
48aab1cf16
PyLink/docs/technical
History
James Lu 48aab1cf16 docs/services-api: revise 
- Rewrite lead section to be more concise
- Move to snake case method names
- Consistently use the terms "services" and "service bots"

[skip ci]
2017-10-05 19:21:52 -07:00
..
doxygen.conf Doxygen configuration & autorun script 2016-07-23 19:42:17 -07:00
doxygen.sh Doxygen configuration & autorun script 2016-07-23 19:42:17 -07:00
hooks-reference.md docs: get rid of self.irc, self.proto, irc.proto 2017-06-25 02:10:03 -07:00
permissions-api.md permissions-api: fix markdown syntax [skip ci] 2017-09-08 19:02:51 -07:00
pmodule-spec.md pmodule-spec: mention in detail how users are tracked 2017-10-05 18:18:09 -07:00
protocol-modules.dot docs: update protocol-modules graphic 2017-07-05 03:28:28 -07:00
protocol-modules.png docs: update protocol-modules graphic 2017-07-05 03:28:28 -07:00
README.md docs/t: remove future articles that won't be around for a while 2017-10-05 19:05:36 -07:00
release-process.md docs: Refresh release-process.md 2017-10-05 18:20:59 -07:00
services-api.md docs/services-api: revise 2017-10-05 19:21:52 -07:00
using-ircparser.md using-ircparser.md: minor tweaks and reordering 2017-03-12 20:45:42 -07:00
writing-plugins.md Remove plugins/example_service, it is out of date and broken with 2.x 2017-10-05 19:08:28 -07:00

README.md

PyLink Developer Documentation

This documentation is provided for reference only, and may not always be up to date as APIs change. Patches are welcome if something looks wrong or is wrong. In such cases, consulting the source code is probably your best bet.

The docs are also really incomplete (contributions are appreciated!)

Introduction

PyLink is an a modular, plugin-based IRC services framework. It uses swappable protocol modules and a hooks system for calling plugins, allowing them to function regardless of the IRCd used.

Contents