diff --git a/README.md b/README.md index 5dad75d..d63ab22 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,14 @@ # XtendR -A python 3 extension system to ease the use of plugins. \ No newline at end of file +A very basic python 3 extension system to ease the use of plugins. + +At the moment only 4 functions are available: +- Attach +- Run +- Stop +- Detach + +Attach and Detach are used for registrering/unregistrering a module on the system. +The Run and Stop functions are mandatory in the plugin modules. + +The example.py file shows the workings of this plugin system. \ No newline at end of file