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.

### 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 hooks reference](hooks-reference.md)
- [PyLink protocol module specification](pmodule-spec.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.`

			`### 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 hooks reference](hooks-reference.md)`
			`- [PyLink protocol module specification](pmodule-spec.md)`
			`- [Writing tests for PyLink modules](writing-tests.md)`
			`- [Using PyLink's utils module](using-utils.md)`