From ac4f9c79905fea214e65d1b38136f8a34241c883 Mon Sep 17 00:00:00 2001
From: Paul Lecuq <paul.lecuq@datexim.ai>
Date: Thu, 9 Sep 2021 13:20:13 +0200
Subject: [PATCH] added README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..609e52c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,77 @@
+# zabbixlaunch
+
+## Summary
+
+zabbixlaunch is a application that take control over a launchpad mini, and draw problems handled by Zabbix
+
+
+## Howto
+
+### Sample config in config.json
+
+```json
+{
+  "server": "https://zabbix.acme.com/api_jsonrpc.php",
+  "username": "bob",
+  "password": "password",
+  "authtoken": "token",
+  "limit": 20
+}
+```
+
+### Dev Run
+
+```
+cargo run
+```
+
+### Build
+
+```bash
+cargo build --release
+```
+
+### Prod Run
+
+```bash
+./zabbixlaunch -c config.json
+```
+
+
+## TODO
+
+* Implement a web interface
+* Group problems by criteria
+* Implement inputs
+
+
+## License
+
+```text
+Copyright (c) 2021 PaulBSD
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+The views and conclusions contained in the software and documentation are those
+of the authors and should not be interpreted as representing official policies,
+either expressed or implied, of this project.
+```
\ No newline at end of file