diff --git a/README.md b/README.md index 31dfe63..13227a2 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,19 @@ # XtendR -A very basic python 3 extension system to ease the use of plugins. +A very basic Python >= 3.12 extension system based on the K.I.S.S principle. + +I was in need of a new plugin system, which should meet these requirements: +- Simple to use +- Work well with Python 3.12 +- Maintainable - Don't expect to see new releases every month. __If it ain't broken, don't fix it!!!__ + +I previously used yapsy, but it doesn't meet the requirements anymore. +:x: No longer simple, and simple to use (Simplicity in use has been sacrificed for more complexity. It has become bloated) +:x: Not workink with Python 3.12 +:x: No longer maintained (Hasn't been maintained for a few years) + +I didn't find anything that suited my needs, so I decided to make my own. +It simply contains 2 classes, one for the plugin system and one abstraction base class for the plugins themselves. At the moment only 4 functions are available: - Attach