From 8cf7057e4c351646e64f5783c6f1e7b9dab2c08a Mon Sep 17 00:00:00 2001
From: Nathaniel Landau <nate@natelandau.com>
Date: Wed, 21 Jul 2021 15:03:57 -0400
Subject: [PATCH] Document alert variables

---
 README.md | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 5835f1d..398262c 100644
--- a/README.md
+++ b/README.md
@@ -90,7 +90,7 @@ _sourceHelperFiles_
 ```
 
 ## alerts.bash
-Basic alerting and setting colors functions (included in scriptTemplate.sh by default).  Print messages to stdout and to a user specified logfile using the following functions.
+Basic alerting, logging, and setting color functions (included in scriptTemplate.sh by default).  Print messages to stdout and to a user specified logfile using the following functions.
 
 ```bash
 debug "some text"     # Printed only when in Verbose mode
@@ -103,6 +103,12 @@ success "some text"   # Prints a success message
 header "some text"    # Prints a header element
 ```
 
+Set the following variables for the alert functions to work.
+
+* `$LOGFILE` - Location of a log file
+* `$LOGLEVEL` - One of: FATAL, ERROR, WARN, INFO, DEBUG, ALL, OFF  (Default is 'ERROR')
+* `$QUIET` - If `true`, nothing will print to STDOUT (Logs files will still be populated)
+
 ## arrays.bash
 Common functions for working with BASH arrays.