From 6cc9924a8fe7d3f1d551df9628011bb87748e90e Mon Sep 17 00:00:00 2001
From: David Florness <david@florness.com>
Date: Sun, 31 Oct 2021 15:00:00 -0400
Subject: [PATCH] Add simple "Usage" section to README

---
 Makefile  |  2 ++
 README.md | 19 +++++++++++++++++--
 2 files changed, 19 insertions(+), 2 deletions(-)
 create mode 100644 Makefile

diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..e9775e4
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,2 @@
+msc-link-bot: go.mod go.sum *.go
+	go build -o $@
diff --git a/README.md b/README.md
index 40feca0..53e7e8c 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,19 @@
 # msc-link-bot
 
-This is re-write of @msclinkbot:matrix.org in golang with support for encrypted
-rooms with the help of <https://maunium.net/go/mautrix>.
+This is re-write of `@msclinkbot:matrix.org` in golang with support for
+encrypted rooms with the help of <https://maunium.net/go/mautrix>.
+
+# Usage
+
+```sh
+# will create ./msc-link-bot
+make
+
+export HOMESERVER=https://matrix.example.org
+export USER_ID=@msclinkbot:example.org
+export DEVICE_ID=FWQXHAAVLA
+export ACCESS_TOKEN=<super_secret_access_token>
+
+# crypto keys will be stored in ./crypto.db
+./msc-link-bot
+```
-- 
2.38.4