diff --git a/README.md b/README.md index 5dad75d..31dfe63 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,17 @@ # 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 system expects a folder called 'plugins', placed at the root, along side your main python file. +Each plugin should be placed in subfolders, named as the plugin, inside the 'plugins' folder. + +The example.py along with the example_plugin.py/json shows the workings of this plugin system. \ No newline at end of file diff --git a/setup.py b/setup.py index 63e315e..dedd700 100644 --- a/setup.py +++ b/setup.py @@ -3,13 +3,13 @@ if __name__ == "__main__": setup( name="XtendR", - version="0.0.3", + version="0.0.4", packages=find_packages(), install_requires=[], author="Jan Lerking", author_email="", description="A modular plugin system for Python.", - url="", + url="www.gitea.com/Lerking/XtendR", classifiers=[ "Programming Language :: Python :: 3.12", "License :: OSI Approved :: MIT License",