Documentation -- part one

Pushing this change to continue work elsewhere.

1 files changed, 20 insertions, 1 deletions

diff --git a/sx-auth.el b/sx-auth.el
index f32e7aa..96523f6 100644
--- a/sx-auth.el
+++ b/sx-auth.el
@@ -46,7 +46,26 @@ what you are doing!")
 
 Authentication is required to read your personal data (such as
 notifications) and to write with the API (asking and answering
-questions)."
+questions).
+
+When this function is called, `browse-url' is used to send the
+user to an authorization page managed by StackExchange.  The
+following privileges are requested:
+
+* read_inbox
+    use SX to manage and visit items in your inbox
+
+* write_acesss
+    write comments, ask questions, and post answers on your
+    behalf
+
+* no_expiry
+    do not pester you to reauthorize again
+
+After authorization with StackExchange, the user is then
+redirected to a website managed by SX.  The access token required
+to use authenticated methods is included in the hash (which is
+parsed and displayed prominently on the page)."
   (interactive)
   (setq
    sx-auth-access-token