From 2b5a263d486926c235fe545e5ca44d0c2aec9d11 Mon Sep 17 00:00:00 2001
From: Julien Riou <julien@riou.xyz>
Date: Thu, 26 Nov 2020 14:58:40 +0100
Subject: [PATCH] Add configuration file to README

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

diff --git a/README.md b/README.md
index 56220aa..add12e2 100644
--- a/README.md
+++ b/README.md
@@ -41,6 +41,15 @@ Then reload service:
 systemctl reload nagios4
 ```
 
+## Configuration file
+
+Format used is JSON with the following keys:
+
+* `chat_id`: where to send message on Telegram
+* `auth_key`: key used to authenticate on Telegram
+* `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
 
 Errors logs can be set with the `--logfile` argument.