From 7fa647c95391edff0b3f1c8503dad1e7b4625a04 Mon Sep 17 00:00:00 2001
From: Julien Riou <julien@riou.xyz>
Date: Thu, 26 Nov 2020 15:06:25 +0100
Subject: [PATCH] Update README with template variables

Signed-off-by: Julien Riou <julien@riou.xyz>
---
 README.md | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index add12e2..bc78816 100644
--- a/README.md
+++ b/README.md
@@ -50,7 +50,7 @@ Format used is JSON with the following keys:
 * `host_template` (optional): path to Markdown template file used for sending host notifications
 * `service_template` (optional): path to Markdown template file used for sending service notifications
 
-## Logs
+## Logging
 
 Errors logs can be set with the `--logfile` argument.
 
@@ -80,3 +80,24 @@ They can be overriden in the configuration file:
 ```
 
 Both options are optional.
+
+### Host variables
+
+Variables replaced in the host template:
+* `notification_type` (= `$NOTIFICATIONTYPE$`)
+* `host_name` (= `$HOSTNAME$`)
+* `host_state` (= `$HOSTSTATE$`)
+* `host_address` (= `$HOSTADDRESS$`)
+* `host_output` (= `$HOSTOUTPUT$`)
+* `long_date_time` (= `$LONGDATETIME$`)
+
+### Service variables
+
+Variables replaced in the service template:
+* `notification_type` (= `$NOTIFICATIONTYPE$`)
+* `service_desc` (= `$SERVICEDESC$`)
+* `host_alias` (= `$HOSTALIAS$`)
+* `host_address` (= `$HOSTADDRESS$`)
+* `service_state` (= `$SERVICESTATE$`)
+* `long_date_time` (= `$LONGDATETIME$`)
+* `service_output` (= `$SERVICEOUTPUT$`)