summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorshoshin <shoshin@cicadas.surf>2022-10-16 21:11:51 -0500
committershoshin <shoshin@cicadas.surf>2022-10-16 21:11:51 -0500
commit06f93a2a3472398abe2da01e309dcc615fc5d402 (patch)
treef788262298cdd8c015f9f2d5c084b9c823d0fdbf /README.md
parent1d059a579432d19f96be5c191bdcb5c1ce5953c1 (diff)
Docs: config notesHEADmain
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index aacd1e7..da8123e 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,20 @@
Dice rolling bot for Matrix using the granolin bot framework.
More documentation will come...
+## Setup
+
+Create a `snekeyes.config` file in the directory from which
+you will launch the bot.
+
+```
+(:ssl t ;; in the case of a local testing server, the default is t
+ :hardcopy "snekeyes.hardcopy" ;; for recovering sessions, this file will be created
+ :user-id "some-id" ;; the user you have already created on your server for the bot
+ :password "some-password"
+ :homeserver "matrix.cicadas.surf" ;; or your real one
+)
+```
+
## Commands
Currently, `snekeyes` supports two commands: