From 0105907e2061c067001a52ab8b20fa3b4057a205 Mon Sep 17 00:00:00 2001 From: C-Duv Date: Sat, 11 Feb 2017 15:18:18 +0100 Subject: [PATCH] Adds meaning about configuration variables in README This commit explains, in the README, what each configuration variable do. --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index bd66e6b..b640ae3 100644 --- a/README.md +++ b/README.md @@ -25,11 +25,13 @@ See `send-notification.sh -h`. Script can be configured Edit `send-notification.sh` and set the following variables: +* `USER_LOGIN`: The login to use the API. +* `API_KEY`: The secret key associated to `USER_LOGIN`. +* `MESSAGE_HEADER` (Optional): Will be prepended to all the messages. +* `MESSAGE_FOOTER` (Optional): Will be appended to all the messages. +* `NEWLINE_CHAR` (Optional): Char to use to create a new line (it depends on + receiving terminal). -* `USER_LOGIN` -* `API_KEY` -* `MESSAGE_HEADER` (Optional) -* `MESSAGE_FOOTER` (Optional) PHP Client ----------