n07070/sms-api-free-mobile
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Adds meaning about configuration variables in README

Browse Source 
This commit explains, in the README, what each configuration variable do.
This commit is contained in:
C-Duv 2017-02-11 15:18:18 +01:00
parent 3304fde7a3
commit 0105907e20
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -25,11 +25,13 @@ See `send-notification.sh -h`.
Script can be configured Script can be configured
Edit `send-notification.sh` and set the following variables: 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 PHP Client
---------- ----------