From ec3096fb50957e4e248c8b0e307f3770bbcbc9bd Mon Sep 17 00:00:00 2001
From: jesopo <github@lolnerd.net>
Date: Thu, 14 Feb 2019 12:28:36 +0000
Subject: [PATCH] Put information about `USERPASS` in sasl/README.md

---
 modules/sasl/README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/modules/sasl/README.md b/modules/sasl/README.md
index 895bd81d..30a51e08 100644
--- a/modules/sasl/README.md
+++ b/modules/sasl/README.md
@@ -2,10 +2,18 @@
 
 You can either configure SASL through `!serverset sasl` from an registered and identified admin account or directly through sqlite.
 
+## USERPASS Mechanism
+
+BitBot supports a special SASL mechanism name: `USERPASS`. This internally 
+represents "pick the strongest username:password algorithm"
+
 ## !serverset sasl
 
 These commands are to be executed from a registered admin account
 
+#### USERPASS
+> !serverset sasl userpass &lt;username>:&lt;password>
+
 #### PLAIN
 > !serverset sasl plain &lt;username>:&lt;password>
 
@@ -22,6 +30,9 @@ These commands are to be executed from a registered admin account
 
 Execute these against the current bot database file (e.g. `$ sqlite3 databases/bot.db`)
 
+#### USERPASS
+> INSERT INTO server_settings (&lt;serverid>, 'sasl', '{"mechanism": "userpass", "args": "&lt;username>:&lt;password>"}');
+
 #### PLAIN
 > INSERT INTO server_settings (&lt;serverid>, 'sasl', '{"mechanism": "plain", "args": "&lt;username>:&lt;password>"}');