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)

#### Future topics (not yet available)

- [PyLink hooks reference](hooks-reference.md)
- [Writing tests for PyLink modules](writing-tests.md)
- [Using PyLink's utils module](using-utils.md)
Initial documentation stub (docs/technical/) 2015-08-06 08:31:53 +02:00			`## 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.`

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!)`

Initial documentation stub (docs/technical/) 2015-08-06 08:31:53 +02:00			`### Introduction`

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
			`### Contents`

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)`
docs: add auto-generated InspIRCd protocol spec, and finish off most of writing-plugins.md 2015-09-07 08:11:31 +02:00
			`#### Future topics (not yet available)`

			`- [PyLink hooks reference](hooks-reference.md)`
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)`
			`- [Using PyLink's utils module](using-utils.md)`