diff options
Diffstat (limited to 'plugin/README.md')
-rw-r--r-- | plugin/README.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/plugin/README.md b/plugin/README.md new file mode 100644 index 0000000..852cfe5 --- /dev/null +++ b/plugin/README.md | |||
@@ -0,0 +1,12 @@ | |||
1 | # Plugin | ||
2 | |||
3 | A library for loading plugins and watching plugin updates. | ||
4 | |||
5 | The plugin engine allows the client to load plugins and call their functions. | ||
6 | |||
7 | Plugins can also be associated with a state. The engine does not create the | ||
8 | plugin's state because this may require other application-specific state. | ||
9 | |||
10 | Plugin files are watched for updates. Upon an update, the engine reloads the | ||
11 | plugin into memory and notifies the client. The client should then typically | ||
12 | re-create the plugin's state. | ||