From 8574790775b3850afc008e10db0de584c726e4df Mon Sep 17 00:00:00 2001
From: Dominik Meyer <dmeyer@federationhq.de>
Date: Fri, 20 Dec 2019 18:31:57 +0100
Subject: [PATCH] ADD: updated README.md

---
 README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 50 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 38b5347..c94aed1 100644
--- a/README.md
+++ b/README.md
@@ -2,16 +2,60 @@
 
 ## Description
 
-OSSEC Active Response script to send jabber messages through sendxmpp.
+This is an  active response script for OSSEC(https://www.ossec.net/), written in perl,
+to send jabber(xmpp) messages of certain alerts.
+
+
+
+## Requirements
+
+- Perl
+- sendxmpp program
+- OSSEC Perl Module
+
+## INSTALL
+
+### Stable Version
+The stable version can always be installed from CPAN using the *cpan*
+tool of your linux distribution.
+
+### Git install
+
+For installing fresh from the git repository you need a perl installation including the Dist::Zilla package. The use of plenv(https://github.com/tokuhirom/plenv) is encouraged.
+
+```{r, engine='bash', code_block_name}
+git clone https://gitcloud.federationhq.de/byterazor/App-OSSEC-Jabber.git
+cd App-OSSEC-Jabber
+dzil build
+cpanm App-OSSEC-Jaber<version>.tar.gz
+```
+
+### OSSEC specific
+
+- Please link the script into your OSSEC active response bin directory
+to be able to execute it.
+- configure the command in your ossec.conf
+- configure the active response for every alert leve/ rule you want the command to be triggert
+- place a jabber.conf file in your ossec etc directory
+
+#### Example jabber.conf
+```{r, engine='xml'}
+<config>
+  <options>-t</options>
+  <recipients>
+    <recipient>your@jabber.de</recipient>
+  </recipients>
+</config>
+```
+
+### sendxmpp
+
+Plase make sure sendxmpp is installed and you have a working configuration to send jabber messages to your recipients.
 
 ## Author
 
 Dominik Meyer <dmeyer@federationhq.de>
 
-## INSTALL
-
-coming soon
-
-### LICENSE
+## LICENSE
 
 GPLv3