Update documentation for version 2.0

This commit is contained in:
Jeremy 2023-01-01 12:03:47 +13:00
parent 88e373a777
commit a112ef195a
9 changed files with 204 additions and 181 deletions

View file

@ -1,22 +1,16 @@
# matrix-send
A script that sends a message to a Matrix room.
A script that sends messages to Matrix rooms.
[Read the manual page](https://jtbx.codeberg.page/man/matrix-send.1)
---
**Syntax:** `matrix-send message room`
**Example:** `matrix-send "Hello world\!" \!aBcDeFgHiJkLmNoP:example.org`
---
matrix-send is a simple script that sends a message to a Matrix room.
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 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.
It is mainly designed for automation.
There aren't any plans for matrix-send to support encryption.