From 2f8ff39a8d95b95288875d92abb74b1428713906 Mon Sep 17 00:00:00 2001
From: 3gg <3gg@shellblade.net>
Date: Fri, 16 Jun 2023 09:15:34 -0700
Subject: Add plugin library.

---
 plugin/README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)
 create mode 100644 plugin/README.md

(limited to 'plugin/README.md')

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 @@
+# Plugin
+
+A library for loading plugins and watching plugin updates.
+
+The plugin engine allows the client to load plugins and call their functions.
+
+Plugins can also be associated with a state. The engine does not create the
+plugin's state because this may require other application-specific state.
+
+Plugin files are watched for updates. Upon an update, the engine reloads the
+plugin into memory and notifies the client. The client should then typically
+re-create the plugin's state.
-- 
cgit v1.2.3