jeremy/matrix-send
1
Fork 0
Code Releases Activity

Update 'README.md'

Browse source
This commit is contained in:
Jeremy Baxter 2023-01-01 02:44:27 +00:00
parent 496fe6ba3b
commit 7890ded40c
1 changed files with 6 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -6,9 +6,10 @@ A script that sends messages to Matrix rooms.
--- ---
matrix-send is a simple script that sends a message to a Matrix room. matrix-send is a simple script that sends messages to Matrix rooms.
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 directly making requests to the API of your Matrix server.
The supported event types are `m.text` and `m.notice`.
It is mainly designed for automation. It is mainly designed for automation.
@ -16,7 +17,7 @@ There aren't any plans for matrix-send to support encryption.
## Get started ## Get started
In order to start using matrix-send, you need a config file. To copy the default configuration to .config, clone this repository and type `make config` as the desired user (not root). In order to start using matrix-send, you need a config file. To copy the default configuration to .config, clone this repository and type `make config` as your user (not root).
Now edit the file ~/.config/matrix-send/config.lua. You will first see the `login` table. Now edit the file ~/.config/matrix-send/config.lua. You will first see the `login` table.
@ -54,7 +55,7 @@ To send a message, type `matrix-send` followed by your message and then your Roo
matrix-send 'Hi!' \!asdfasdfasdfasdf:matrix.org matrix-send 'Hi!' \!asdfasdfasdfasdf:matrix.org
``` ```
That will send the message "Hi!" to the Matrix room !asdfasdfasdfasdf:matrix.org. That will send the message "Hi!" to the Matrix room `!asdfasdfasdfasdf:matrix.org.`
If you don't want to type the long room ID every time, you can add an alias. If you don't want to type the long room ID every time, you can add an alias.
@ -83,4 +84,4 @@ rooms = {
} }
``` ```
For more information, see [matrix-send(1)](https://jtbx.codeberg.page/man/matrix-send.1). For more information, see [matrix-send(1)](https://jtbx.codeberg.page/man/matrix-send.1) and [matrix-send-config(5)](https://jtbx.codeberg.page/man/matrix-send-config.5).