aboutsummaryrefslogtreecommitdiff
path: root/plugin/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugin/README.md')
-rw-r--r--plugin/README.md12
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
3A library for loading plugins and watching plugin updates.
4
5The plugin engine allows the client to load plugins and call their functions.
6
7Plugins can also be associated with a state. The engine does not create the
8plugin's state because this may require other application-specific state.
9
10Plugin files are watched for updates. Upon an update, the engine reloads the
11plugin into memory and notifies the client. The client should then typically
12re-create the plugin's state.