From 7145d1818350af8d793bea68a354707248666fa3 Mon Sep 17 00:00:00 2001 From: Oxbian Date: Sun, 8 Oct 2023 22:02:22 +0200 Subject: Updating project to be POSIX sh and creating a man page --- README.md | 41 +++++++++++++++++++++++------------------ 1 file changed, 23 insertions(+), 18 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index efa3dce..add85d0 100644 --- a/README.md +++ b/README.md @@ -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 +```sh +./matrix-sender -t ``` Once all is setup, you can send messages: - Simple message -```bash -./matrix.sh -s +```sh +./matrix-sender -s ``` -- HTML formatted message -```bash -./matrix.sh -html +- or an HTML formatted message +```sh +./matrix-sender -html ``` 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 '

t e s t

' +./matrix-sender -html '

t e s t

' ``` ## Contributing -- cgit v1.2.3