From f74a76517b44e0efae989e43727ed4cc200433e7 Mon Sep 17 00:00:00 2001
From: Jonathan Mainguy <jon@soh.re>
Date: Sat, 15 Feb 2020 08:26:44 -0500
Subject: [PATCH] update readme

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

diff --git a/README.md b/README.md
index 8e18a4c..1d9d698 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,26 @@
 # kibanaRefreshFields
 Refresh kibana index fields via kibanas API
+## Expected variables
+I have this setup in my ~/.bashrc, another deployment would be to place this in k8s.
+```/bin/bash
+export KIBANA_USERNAME=jmainguy
+export KIBANA_PASSWORD="supersecret"
+export KIBANA_URL=logs-lab.example.com
+export KIBANA_INDEX="filebeat-*"
+# Optional, if you want to filter out some fields
+export KIBANA_FILTER="kubernetes.labels.jenkins"
+```
+
+## Usage
+```/bin/bash
+./kibanaRefreshFields
+```
+
+## PreBuilt Binaries
+Grab Binaries from [The Releases Page](https://github.com/Jmainguy/kibanaRefreshFields/releases)
+
+## Build
+```/bin/bash
+export GO111MODULE=on
+go build
+```