Reaktor.Plugins.SASL: init

1 files changed, 19 insertions, 0 deletions

diff --git a/README.md b/README.md
index c5a5cc6..f661d70 100644
--- a/README.md
+++ b/README.md
@@ -70,3 +70,22 @@
     curl -fsSv --unix-socket /path/to/reaktor.sock http://dontcare/ \
         -H content-type:application/json \
         -d "$(jq -n '{command:"PRIVMSG",params:["#somechannel","derp!"]}')"
+
+# SASL
+
+  To use SASL for authentication, merge following snippet into your configuration:
+
+    {
+      "plugins": [
+        {
+          "plugin": "sasl",
+          "config": {
+            "mechanism": "PLAIN",
+            "username": "somename",
+            "password": "SOMEPASSWORD"
+          }
+        }
+      ]
+    }
+
+  Note that at the moment only SASL PLAIN is supported.