jeremy/matrix-send
1
Fork 0
Code Releases Activity

Update 'README.md'

Browse source
This commit is contained in:
Jeremy 2022-07-28 22:17:09 +02:00
parent 6ca4fe2d3f
commit 2eb5ac04fe
1 changed files with 9 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -1,6 +1,9 @@
# matrix-send
A script to send a message to a Matrix room.
[Read the manual page](https://codeberg.org/jtbx/matrix-send/src/branch/master/doc/matrix-send.1.md)
---
**Syntax:** `matrix-send message room`
@ -11,11 +14,11 @@ A script to send a message to a Matrix room.
`matrix-send` is a simple script to send a message to a Matrix room.
It does this by sending a JSON message to your Matrix server. The message type supported is currently only m.text, but other types will be supported.
It does this by sending a JSON message to your Matrix server. The message types that are supported are *m.text*, and *m.notice*.
It is mainly designed for automation. I use it on a private Matrix room of mine.
`matrix-send` doesn't have support for end-to-end encryption, and never will.
There aren't any plans for `matrix-send` to support encryption.
## Get started
@ -43,14 +46,16 @@ Password $(gpg -d /path/to/passwd.gpg)
/path/to/passwd.gpg is a GPG-encrypted file containing only your password, once decrypted.
For more configuration options, see [matrix-send.conf(5)](https://codeberg.org/jtbx/matrix-send/src/branch/master/doc/matrix-send.conf.5.md).
---
To install matrix-send, run `make install` as root, in the cloned repository's directory.
```shell
```
# make install
```
In order to send messages, you need your Room ID. Find the room you want to send to, and find its Room ID in the settings or somewhere else. It will likely be under Advanced or something similar.
In order to send messages, you will need your Room ID. Find the room you want to send to, and find its Room ID in the settings or somewhere else. It will likely be under Advanced or something similar.
To send a message, type `matrix-send` followed by your message and then your Room ID. You may need to escape the exclamation mark(s). For example: