From 2bd7573770e31be4d0f23708a83c6cb42b7ee66a Mon Sep 17 00:00:00 2001
From: Christoph Haas <christoph.h@sprinternet.at>
Date: Wed, 21 Dec 2016 21:00:47 +0100
Subject: [PATCH] Updated README

---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/README.md b/README.md
index e69de29..bc5e9e2 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,21 @@
+### Joomla integrity and version check script
+
+This script is usefull to check joomla versions on a webserver. It does also check integrity of joomla core files!
+All outputs are written to a csv file for better automation.
+
+#### Usage
+
+```
+checkjoomla.py [-h] [-v] [-n]
+```
+
+optional arguments:
+ - -h, --help:         show this help message and exit
+ - -v, --verbose:      Print verbose output
+ - -n, --nointegrity:  Skip integrity check
+
+
+#### Configuration
+
+Make sure to set the variable ```base_path``` to your base webroot directory. In case you are using plesk it might be ```/var/www/vhosts```.  
+Also mare sure to configure the other options in the CONFIG section of the script.
\ No newline at end of file