degraded fix

Author: Cyclenerd

.github/workflows/demo_page.yml

@@ -28,6 +28,7 @@ jobs:
           echo 'curl;ftp://ftp.usa.openbsd.org/pub/OpenBSD/timestamp|ftp.usa.openbsd.org (curl)' >> status_hostname_list.txt
           echo 'nc;8.8.8.8|DNS @ Google (nc);53' >> status_hostname_list.txt
           echo 'script;/bin/true|Always up (/bin/true)' >> status_hostname_list.txt
+          echo 'script;exit 80|Always degraded (exit 80)' >> status_hostname_list.txt
           echo 'script;/bin/false|Always down (/bin/false)' >> status_hostname_list.txt
           echo "config"
           cat config

README.md

@@ -21,7 +21,7 @@ With the script `alert.sh`, you can be alerted by email, SMS or Pushover in case
 ##  Installation 📦
 
 By default, it's a good practice to create a `status` directory within your home directory and place everything in it :
-```
+```shell
 mkdir ~/status
 cd ~/status
 ```
@@ -95,7 +95,7 @@ crontab -e
 
 Add:
 
-```
+```text
 */1 * * * * bash "/path/to/status.sh" silent >> /dev/null
 ```
 
@@ -135,7 +135,7 @@ You can display a custom text instead of the HOSTNAME/IP/URL (see example below)
 
 status_hostname_list.txt:
 
-```csv
+```text
 ping;8.8.8.8|Google DNS
 nc;8.8.8.8|DNS @ Google;53
 curl;http://www.heise.de/ping|www.heise.de
@@ -173,30 +173,33 @@ Example JSON:
 If you want to signal directly if everything is fine or if something is wrong in the infrastructure, you can insert the SVG icon into your website.
 
 Please remember to include the image with a cache breaker URL (eg. an appended timestamp:
-```
+```html
 <a href="status.html">Status <img src="status.svg?{{ timestamp }}"></a>
 ```
 
 Static websites need to fallback to render the icon with javascript, eg with:
-```
+```html
 document.write('<img src="status.svg?' + Date.now() + '">')
 ```
 
 ## Custom Script Checks 🛠️ 
 
 You can extend the checks of `status.sh` with your own custom shell scripts.
 
-If the shell script outputs a return code 0 it is evaluated as available. With other return codes, it is a failure (outage, down).
+If the shell script outputs a return code `0` it is evaluated as available.
+With the special return code `80`, it is not classified as down but as degraded.
+With all other return codes, it is a failure (outage, down).
 
 Add your script to the `status_hostname_list.txt` configuration file. Example:
 
-```
+```text
 script;script.sh
 script;/path/to/your/script.sh|Custom Text
 script;/path/to/your/script.sh parameterA parameterB|Custom Text
-
 ```
 
+The script [`check-websites.sh`](./scripts/check-websites.sh) is an example.
+
 ## TODO ✅
 
 1. **Bug Fixes and Enhancements**: Address any reported issues and consider adding new features to improve the script's functionality.