diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 14 |
1 files changed, 14 insertions, 0 deletions
@@ -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: |