From 05b80e4bee51ac3c2eac45da50a3b07f0fbc4d68 Mon Sep 17 00:00:00 2001
From: Michael Clemens <clemens@fsfe.org>
Date: Thu, 15 Mar 2018 17:50:41 +0100
Subject: [PATCH] updated README

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

diff --git a/README.md b/README.md
index 8510b38..8aabb43 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,15 @@
 # esm2markdown
+
+This python script is intended to be used to automatically generate use case / correlation rule documentation in Markdown format for the McAfee Enterprise Sceurity Manager (ESM). It accepts a XML file that has been exported from the correlation rule editor of the ESM, converts its contents to Markdown format and writes it into a new file. If you need any other format, you might want to use pandoc to convert to e.g. pdf, docx or HTML.
+
+## Usage
+
+```
+python esm2markdown <rule xml file> <markdown output file>
+```
+
+## Example
+
+```
+python esm2markdown RuleExport_2018_03_01_12_36_37.xml documentation.mk
+```