From 75577fa829b21bc090e8f3b229e8929ba5be2160 Mon Sep 17 00:00:00 2001
From: Lukas Macura <lukas@macura.cz>
Date: Thu, 5 Jan 2017 18:07:04 +0100
Subject: [PATCH] Added README for booked

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

diff --git a/booked/README.md b/booked/README.md
new file mode 100644
index 0000000..81cbc3e
--- /dev/null
+++ b/booked/README.md
@@ -0,0 +1,41 @@
+# Booked (phpscheduleit) plugin for Zaf
+
+Booked is opensource reservation system using PHP. More info can be found at http://www.bookedscheduler.com/.
+This Zaf plugin supports fetching informations from this system and find if there is some reservation in given time range.
+This is usefull for scripting and alerting. 
+
+If you need more info about installing zaf: https://github.com/limosek/zaf
+
+## How to use
+
+First, create account in Booked with required access to system and enable API. Next, simply install 
+```
+zaf install booked
+```
+
+It will ask you for url to booked API, username and password. 
+After it, import template into Zabbix server: https://raw.githubusercontent.com/limosek/zaf-plugins/master/booked/template.xml 
+
+## Supported items
+
+Items supported now.
+
+### booked.is_first
+
+This item will return 0 or 1 depending on fact, if reservation at given time is first at given timerange.
+
+To test, if reservation after 1 hour is first at this day:
+```
+booked.is_first[+1hour,day]
+```
+
+### booked.num_reservations
+
+This item will return number of reservations in given timerange.
+
+To get number of reservations tomorow:
+```
+booked.num_reservations[00:00+1day,00:00+2day]
+```
+
+