-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
19 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,21 @@ | ||
# EventumPlugins | ||
Plugins for Eventum | ||
|
||
## Overview | ||
Package includes next types of plugins for Eventum: | ||
1. Input plugins | ||
2. Event plugins | ||
3. Output plugins | ||
|
||
Current list of implemented plugins and their description: https://eventum-generatives.github.io/Website/docs/plugins/ | ||
|
||
## Developing | ||
When developing new plugins you should follow next clauses: | ||
1. Plugin is a separate module within a package | ||
2. Plugin class should inherit base class | ||
3. Each plugin should define its configuration class that inherits base config class | ||
4. Plugin module should contain defined `PLUGIN_CLASS` and `CONFIG_CLASS` variables (it automatically marks plugins as plugable) | ||
|
||
If you want your plugin to be merged, please: | ||
- write and provide documentation for your plugin by making PR to https://github.com/Eventum-Generatives/Website | ||
- write tests for your plugin |