Doc

README.md

@@ -15,15 +15,15 @@ Use
 
 To add it to the cron tab:
 
-	crontab -e
+	sudo /etc/crontab
 
-The add new line (to run the check once per hour)
+The add new line (to run the check once per hour), don't forget to change the username:
 
-	1 * * * * /home/alban/outils/warn-if-broken/warn-if-broken-url.sh >/dev/null 2>&1
+	1 * * * *  username  /home/caracals/outils/warn-if-broken-url/warn-if-broken-url.sh > /dev/null  2>&1
 
 
 **Note:**
  - Normaly cron send task outputs (echo) via mail. As the MTA (Mail Transfert Agent), may not be set up,
 the crontab line redirect the outputs into `/dev/null`.
- - No sudo is needed, msmtp and crontab are call with current user.
+ - Sudo is needed to update the crontab. It also possible to set up your user crontab with `crontab -e`. In this case, remove `username` from the cron entry.
  - The logs can be seen using (with sudo): `sudo grep CRON /var/log/syslog`

warn-if-broken-url.sh

@@ -4,10 +4,13 @@ set -eu
 
 URL="https://status.caracals.org"
 
-SCRIPT_PATH="$( cd "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P )"
 
+# Move in repo folder
+SCRIPT_PATH="$( cd "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P )"
 pushd ${SCRIPT_PATH} > /dev/null
 
+
+# Test URL
 if ret=$(curl -s -f "${URL}"); then
     echo "Marche"
 else
@@ -15,4 +18,5 @@ else
     cat msg.txt | msmtp alban.bronisz@gmail.com
 fi
 
+# Move back
 popd