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

README: reflow

Browse source
This commit is contained in:
Xiretza 2022-11-13 09:20:18 +01:00
parent 7031f9f82b
commit 047f64c5db
1 changed files with 8 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -4,11 +4,16 @@ Running in [#lobby:it-syndik.at](matrix:r/lobby:it-syndik.at).
## Setup ## Setup
1. Copy `config.toml.example` to `~/.config/its-matrix-bot/config.toml` (or some other location later specified using `-c, --config`) 1. Copy `config.toml.example` to `~/.config/its-matrix-bot/config.toml` (or some other location
2. Run first-time setup using `its-matrix-bot setup [-h HOMESERVER_URL] USERNAME` and enter the bot user's password. 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`. 3. Start the bot using `its-matrix-bot run`.
## Available commands ## Available commands
- `!isitopen`: check if the hackerspace is currently open - `!isitopen`: check if the hackerspace is currently open
- `!spaceping`: play a chime in the hackerpace to attempt to get someone to read your matrix messages - `!spaceping`: play a chime in the hackerpace to attempt to get someone to read your matrix
messages
<!-- vim: set tw=100: -->