From cbe0f9627238a2d9cbb809cd126598843b7d25f3 Mon Sep 17 00:00:00 2001
From: Sean Hinchee <henesy@users.noreply.github.com>
Date: Tue, 15 Jan 2019 19:53:46 -0600
Subject: [PATCH] document auth= stuff

---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/README.md b/README.md
index f6d0fae3d0db95e219aed6349e091ef5e4e52993..910d6a7b42e7962c91cd545e1641079a9c7f892a 100644
--- a/README.md
+++ b/README.md
@@ -33,6 +33,26 @@ Commands available in chat:
 | :p        | Pulls up the private channel menu |
 | :n name   | Change nickname to `name` |
 
+## Config
+
+A normal $home/lib/disco.ndb looks something like:
+
+```
+auth=pass
+loadbacklog=true
+messages=10
+promptchar=→
+timestampchar=>
+
+username=cooldude@mycooldomain.com	password=somepassword1
+```
+
+Note that the auth= tuple accepts
+
+	auth=factotum
+
+for authentication using a factotum key and will ignore the password= tuple.
+
 ## Notes
 
 If you can connect to a channel and see messages, but yours aren't sending, check to make sure your e-mail address is verified.