From c8147185c3cd49f0d48bf6b80b184a7048508709 Mon Sep 17 00:00:00 2001
From: Phil Skentelbery <pskentelbery@splunk.com>
Date: Mon, 9 Nov 2020 20:40:19 -0600
Subject: [PATCH] added documentation

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d6716b7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# failed_login.py
+
+This tool will return all failed logins to the target search head for the past 7 days.
+
+## Installation
+
+**For safety, install to a python virtual environment**
+
+1. Clone the repository ```git clone ```
+2. Install the prerequisites ```pip install requirements.txt```
+
+## Usage
+
+python failed_login.py [OPTIONS]
+
+Options:
+  --host TEXT                     Splunk hostname  [required]
+  --port INTEGER                  Splunk REST API port  [default: 8089]
+  --username TEXT                 Splunk username  [required]
+  --password TEXT                 Splunk password  [required]
+  --help			  Display help