GitHub/PyLink
3
0
Fork 0
mirror of https://github.com/jlu5/PyLink.git synced 2024-11-27 21:19:31 +01:00
Code Issues Projects Releases Wiki Activity

docs/: fill in Contents, where future docs will go

Browse Source
This commit is contained in:
James Lu 2015-08-09 14:36:46 +08:00
parent 4fef587014
commit 67d8bc8e1f
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/technical/README.md
View File

@ -5,10 +5,14 @@ Any documentation here is provided for reference only.
### Introduction
PyLink is a modular, plugin-based IRC PseudoService framework. It uses swappable protocol modules and a hook-based system for calling plugins, which aim, together, to provide a consistent API.
PyLink aims to be 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
TBD.
- [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)