PyLink/docs/technical/README.md

# PyLink Developer Documentation

Please note that as PyLink is still in its development phase, the API is subject to change.
Any documentation here is provided for reference only.

It is also really incomplete (contributors welcome!)

## Introduction

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

<img src="core-structure.png" width="50%" height="50%">

## Contents

- [Writing plugins for PyLink](writing-plugins.md)
- [PyLink protocol module specification](pmodule-spec.md)
- [Using PyLink's utils module](using-utils.md)

### WIP topics
- [PyLink hooks reference](hooks-reference.md)

### Future topics (not yet available)
- [Writing tests for PyLink modules](writing-tests.md)
docs: add part of hooks-reference, mention topics and modes in protocol module spec, some more changes ref: #113. 2015-12-27 01:44:22 +01:00			`# PyLink Developer Documentation`
Initial documentation stub (docs/technical/) 2015-08-06 08:31:53 +02:00
			`Please note that as PyLink is still in its development phase, the API is subject to change.`
			`Any documentation here is provided for reference only.`

docs: add auto-generated InspIRCd protocol spec, and finish off most of writing-plugins.md 2015-09-07 08:11:31 +02:00			`It is also really incomplete (contributors welcome!)`

docs: add part of hooks-reference, mention topics and modes in protocol module spec, some more changes ref: #113. 2015-12-27 01:44:22 +01:00			`## Introduction`
Initial documentation stub (docs/technical/) 2015-08-06 08:31:53 +02:00
docs/: Start work on writing-plugins.md, improvements to example plugin 2015-08-24 21:10:14 +02:00			`PyLink is an a modular, plugin-based IRC PseudoService framework. It uses swappable protocol modules and a hook-based system for calling plugins, allowing them to function regardless of the IRCd used.`
Initial documentation stub (docs/technical/) 2015-08-06 08:31:53 +02:00
docs/: smaller image 2015-08-06 12:10:21 +02:00			`<img src="core-structure.png" width="50%" height="50%">`
Initial documentation stub (docs/technical/) 2015-08-06 08:31:53 +02:00
docs: add part of hooks-reference, mention topics and modes in protocol module spec, some more changes ref: #113. 2015-12-27 01:44:22 +01:00			`## Contents`
Initial documentation stub (docs/technical/) 2015-08-06 08:31:53 +02:00
docs/: fill in Contents, where future docs will go 2015-08-09 08:36:46 +02:00			`- [Writing plugins for PyLink](writing-plugins.md)`
			`- [PyLink protocol module specification](pmodule-spec.md)`
Doc updates: +using-utils.md stub; update autogenerated references for protocols/inspircd, utils 2015-10-04 01:39:52 +02:00			`- [Using PyLink's utils module](using-utils.md)`
docs: add part of hooks-reference, mention topics and modes in protocol module spec, some more changes ref: #113. 2015-12-27 01:44:22 +01:00
			`### WIP topics`
docs: add auto-generated InspIRCd protocol spec, and finish off most of writing-plugins.md 2015-09-07 08:11:31 +02:00			`- [PyLink hooks reference](hooks-reference.md)`
docs: add part of hooks-reference, mention topics and modes in protocol module spec, some more changes ref: #113. 2015-12-27 01:44:22 +01:00
			`### Future topics (not yet available)`
docs/: fill in Contents, where future docs will go 2015-08-09 08:36:46 +02:00			`- [Writing tests for PyLink modules](writing-tests.md)`