diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 41 |
1 files changed, 23 insertions, 18 deletions
@@ -1,5 +1,5 @@ # Matrix Sender ------- +--- This script allows you to send simple unencrypted message & html to matrix. It can be usefull for logging / cronjobs error or monitoring. @@ -9,8 +9,13 @@ It can be usefull for logging / cronjobs error or monitoring. This script **is dependent of jq & curl**. To install the script, just clone this repo: -```bash -git clone https://github.com/oxbian/matrix-sender.git +```sh +git clone https://git.arka.rocks/Oxbian/matrix-sender +``` + +And if you want you can add it to the PATH or link it to the `/bin` folder. +```sh +sudo ln -s $(pwd)/matrix-sender /bin/matrix-sender ``` ## Usage @@ -18,37 +23,37 @@ git clone https://github.com/oxbian/matrix-sender.git First you need to edit the script with your homeserver url & the roomID After this you need to get your token -```bash -./matrix.sh -t <username> <password> +```sh +./matrix-sender -t <username> <password> ``` Once all is setup, you can send messages: - Simple message -```bash -./matrix.sh -s <message> +```sh +./matrix-sender -s <message> ``` -- HTML formatted message -```bash -./matrix.sh -html <message> +- or an HTML formatted message +```sh +./matrix-sender -html <message> ``` For help you can use: -```bash -./matrix.sh -h +```sh +./matrix-sender -h ``` - -```bash -./matrix.sh --help +or +```sh +./matrix-sender --help ``` -**Exemple** +**Example** ```bash -./matrix.sh -s 'Hello world!' +./matrix-sender -s 'Hello world!' ``` ```bash -./matrix.sh -html '<h1 class="test"> t e s t </h1>' +./matrix-sender -html '<h1 class="test"> t e s t </h1>' ``` ## Contributing |