IT-Syndikat/its-matrix-bot
14
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Add setup instructions to README

Browse source
This commit is contained in:
Xiretza 2022-11-13 00:40:28 +01:00
parent 1245c823b7
commit c3393c5662
1 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -2,6 +2,12 @@
Running in [#lobby:it-syndik.at](matrix:r/lobby:it-syndik.at).
## Setup
1. Copy `config.toml.example` to `~/.config/its-matrix-bot/config.toml` (or some other location later specified using `-c, --config`)
2. Run first-time setup using `its-matrix-bot setup [-h HOMESERVER_URL] USERNAME` and enter the bot user's password.
3. Start the bot using `its-matrix-bot run`.
## Available commands
- `!isitopen`: check if the hackerspace is currently open