1 files changed, 24 insertions, 0 deletions
diff --git a/plugins/plugin_log/README.md b/plugins/plugin_log/README.md
new file mode 100644
index 00000000..3bd7a097
--- /dev/null
+++ b/plugins/plugin_log/README.md
@@ -0,0 +1,24 @@
+# plugin_log
+
+This showcases a _very_ simplistic "log" plugin, that does nothing more than
+logging incoming messages.
+
+
+## Configuration
+
+The configuration of the plugin is as simple as possible:
+
+* Which "level" should be used for logging (trace, debug, info, warn, error)
+* Whether to acknowledge incoming messages, that means send back a reply
+* Whether to instantiate the process-wide logger (this is because inside a rust
+  process, there can only be one logger instance). This should normally be kept
+  off
+
+Example configuration:
+
+```toml
+level = "debug"
+acknowledge = true
+setup_logger = false
+```
+