gaja-group
/
matrix-bot
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README

This commit is contained in:
Patrick Neff 2020-08-03 18:45:47 +02:00
parent 7e2fbf75ae
commit 51f16780ab
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

@ -13,22 +13,28 @@ Requires libolm to be installed. in Debian this is done with `apt install libolm
Create a virtualenv Create a virtualenv
``` bash
mkdir MATRIX_BOT_DIR mkdir MATRIX_BOT_DIR
virtualenv -p python3 venv virtualenv -p python3 venv
source venv/bin/activate source venv/bin/activate
pip install https://git.gaja-group.com/gaja-group/matrix-bot pip install https://git.gaja-group.com/gaja-group/matrix-bot
```
## Usage ## Usage
Before you can send encrypted messages you must verify the bot with the matrix homeserver. To to login and do this use `matrix-bot verify` Before you can send encrypted messages you must verify the bot with the matrix homeserver. To to login and do this use `matrix-bot verify`
``` bash
cd MATRIX_BOT_DIR cd MATRIX_BOT_DIR
source venv/bin/activate source venv/bin/activate
matrix-bot verify matrix-bot verify
```
After that you can begin sending messages After that you can begin sending messages
``` bash
cd MATRIX_BOT_DIR cd MATRIX_BOT_DIR
source venv/bin/activate source venv/bin/activate
matrix-bot message "Message Content" # To send to the default room matrix-bot message "Message Content" # To send to the default room
matrix-bot message -r '!yourRoomId' "Message Content" # To send to a specific room matrix-bot message -r '!yourRoomId' "Message Content" # To send to a specific room
```