2 files changed, 19 insertions(+), 2 deletions(-)

A Makefile
M README.md

@@ 0,0 1,2 @@
+msc-link-bot: go.mod go.sum *.go
+	go build -o $@

@@ 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
+```