From fb66cb9d3b88e4969e77d02f5c219631b87aa6d8 Mon Sep 17 00:00:00 2001
From: Daniel Ziegler <info@nook24.eu>
Date: Thu, 27 Jul 2017 02:16:46 +0200
Subject: [PATCH] Update readme

---
 README.md              | 44 ++++++++++++++++--------------------------
 composer.json          |  6 +++---
 etc/config.yml.example |  2 +-
 3 files changed, 21 insertions(+), 31 deletions(-)

diff --git a/README.md b/README.md
index 9799786..46cc48a 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,23 @@
-# Alpha code
-This is alpha code! May be things are broken, not implemented or got removed with the stable version.
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License 3 for more details.
+# Statusengine Worker
+Statusengine Worker is a PHP application that will consume the events provided by the Statusengine Broker Module. 
+All status data are save in a database (CrateDB, MySQL or Redis) 
+In addition, the Worker is able to parse and process performance data to store them in a time series databases like Graphite. 
+
+For External Command Routing, it is required to run Statusengine Worker on the same node as your monitoring core is running.
 
-# Requirements
+Visit the [documentation](https://statusengine.org/) for more information about Statusengine Worker
+
+
+## Requirements
 - PHP's composer
 - CrateDB or MySQL
 - Redis
 - php >= 5.5.9
 - Ubuntu 14.04, 16.04 or 16.10
 
-# Install (Ubuntu 14.04)
+## Install (Ubuntu 14.04)
 ````
-apt-get install redis-server php5-redis git
+apt-get install redis-server php5-redis git php5-gearman
 
 mkdir -p /opt/statusengine
 cd /opt/statusengine
@@ -24,43 +27,30 @@ chmod +x worker/bin/*
 composer install
 ````
 
-# Config
+## Config
 ````
 cp worker/etc/config.yml.example worker/etc/config.yml
 ````
 Change `node_name` to a unique name in your monitoring cluster!
 
-# Add node to the cluster
+## Add node to the cluster
 ````
 php bin/Console.php cluster add --nodename NODENAME
 ````
 
-# Usage
+## Usage
 ````
 /opt/statusengine/worker/bin/StatusengineWorker.php
 ````
 
-# Proxy warnign
+## Proxy warnign
 If you are behind a proxy, set `no_proxy=127.0.0.1,localhost` in your `/etc/environment`!
 
-# Statusengine statistics
+## Statusengine statistics
 ````
 /opt/statusengine/worker/bin/bin/Console.php statistics --watch 5
 ````
 
-# ToDos
-* [x] Add Downtimes
-* [X] Add Acknowledgements
-* [x] Add Notifications
-* [x] Add Graphite
-* [x] Implement Query Error handling
-* [x] Add Syslog support
-* [ ] ~~More tests~~
-* [ ] init/systemd support
-* [x] Cronjob to cleanup database
-* [x] Delete old performance data records in CrateDB via cron
-* [x] Implement External Command File
-
 
 ### Delete node from the cluster
 ````
diff --git a/composer.json b/composer.json
index 766a4c7..c5e1fce 100644
--- a/composer.json
+++ b/composer.json
@@ -1,9 +1,9 @@
 {
-  "name": "Statusengine Redis Worker",
+  "name": "Statusengine Worker",
   "description": "The missing event broker + responsive web frontend for Nagios and Naemon",
-  "version": "2",
+  "version": "3",
   "homepage": "https://statusengine.org/",
-  "license": "GPLv2",
+  "license": "GPLv3",
   "authors": [
     {
       "name": "Daniel Ziegler (nook24)",
diff --git a/etc/config.yml.example b/etc/config.yml.example
index 22384a6..13499c5 100644
--- a/etc/config.yml.example
+++ b/etc/config.yml.example
@@ -116,7 +116,7 @@ process_perfdata: 0
 
 # Number of worker processes for service check results
 # Target: You selected this at 'perfdata_backend' option
-number_perfdata_worker: 2
+number_perfdata_worker: 1
 
 # Uncomment to enable
 # You can enable as much backends as you want