From 3bc3b11215a453ee5a167ab698717fc217a741d8 Mon Sep 17 00:00:00 2001
From: Markus Birth <mbirth@gmail.com>
Date: Mon, 6 Oct 2014 18:16:02 +0200
Subject: [PATCH] Added README.

---
 README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a5e801c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+Mailstache for Check_MK
+=======================
+
+Unpack everything to your OMD site's "local" directory so that the final structure is like this:
+
+```
+.../sites/YOURSITE
+           `-local
+               |-lib
+               |   |-external
+               |   |   `-pystache (dir)
+               |   `-python
+               |       `-pystache (Symlink)
+               `-share
+                   `-check_mk
+                       `-notifications
+                           |-mailstache_templates
+                           |   |-foot_html.mustache
+                           |   |-head_html.mustache
+                           |   |-host_html.mustache
+                           |   |-host_subject.mustache
+                           |   |-host_txt.mustache
+                           |   |-service_html.mustache
+                           |   |-service.subject.mustache
+                           |   `-service_txt.mustache
+                           `-mailstache (executable)
+```
+
+If you are using Check_MK without OMD, the directories may differ. You may also have to modify the `mailstache` script accordingly.