From b0dcf7553acc4a161e59017184ee2d75cd601a1e Mon Sep 17 00:00:00 2001
From: David Florness <david@florness.com>
Date: Sat, 22 May 2021 20:59:37 -0400
Subject: [PATCH] README: add description of what the program does on
 invocation

---
 README.md | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 3aa29aa..58c9ec5 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,7 @@ neurons that seem to connect to
 
 # usage
 
-via go get:
+Install via go get:
 ```
 go get git.hnitbjorg.xyz/~edwargix/axon
 $(go env GOPATH)/bin/axon help
@@ -24,6 +24,15 @@ go build
 ./axon help
 ```
 
+When you first run one of the subcommands, you'll be prompted for the username
+and password of a Matrix account.  You'll only be asked for these credentials on
+your first invocation of axon since the access token will get stored in
+`~/.local/shared/axon/auth.json` (with ACL bits 600).  The subcommand will then
+do some little bit of functionality on the Matrix network from the perspective
+of your account using the [Client-Server
+API](https://matrix.org/docs/spec/client_server/r0.6.1).  Run `axon help
+<subcommand>` so see what a given subcommand does.
+
 # contributing
 
 Please send requests/patches to
-- 
2.38.4