From 5459c5a9cd160bbcf56d75887278f702f5c8b680 Mon Sep 17 00:00:00 2001
From: PeaStew <peter.gavin.stewart@gmail.com>
Date: Sun, 24 Apr 2022 13:45:50 +0200
Subject: [PATCH] added details in readme for Splunk reporting

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

diff --git a/README.md b/README.md
index b7c6c27..be28f5b 100644
--- a/README.md
+++ b/README.md
@@ -26,6 +26,7 @@ GLOBAL OPTIONS:
     --output value, -o value  output query results in easy to grasp PDF report
     --print, -p               output technical query results to terminal (default: false)
     --json, -j                output technical query results as json to terminal (default: false)
+    --splunk -s               select a JSON or YAML file to load Splunk output parameters
     --quiet, -q               don't show progress bar (default: false)
     --help, -h                show help (default: false)
     --version, -v             print the version (default: false)
@@ -77,6 +78,17 @@ GLOBAL OPTIONS:
     request_rate: 500
 ```
 
+## Sample Splunk Input
+
+### JSON
+```json
+{
+    "url":"https://example.com/hec/services/collector/event",
+    "authkey":"Splunk xyz",
+    "source": "rtapi for splunk by PeaStew"
+}
+```
+
 ### Default Values
 
 Only the `target.url` parameter is required. If no method is specified the default is "GET", while in the case of the body and headers these will simply remain empty during the benchmark.