From 7fe220cd908f3f1bb54a7e1e9668d5d1ec1f6838 Mon Sep 17 00:00:00 2001
From: Jan Grewe <jan.grewe@flixbus.com>
Date: Thu, 7 Jun 2018 15:58:07 +0200
Subject: [PATCH] Readme: add usage information

---
 README.md | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 390613e..f24d9cf 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,21 @@
 # Nexenta Exporter for Prometheus
 This Prometheus exporter uses the Nexenta API to provide metrics for JBODs, volumes and license informations.
 
-#### Currently implemented metrics:
+### Usage
+The exporter accepts arguments and/or environment variables to set the credentials and connection details.
+
+Flag | Env Var | Default
+--- | --- | ---
+`-api-host` | `API_HOST` | `nexenta`
+`-api-port` | `API_PORT` | `8457`
+`-api-user` | `API_USER` | `admin`
+`-api-password` | `API_PASSWORD` | `password`
+`-api-ssl` | `API_SSL` | `false`
+`-insecure` | `INSECURE` | `false`
+`-listen-address` | `LISTEN_ADDRESS` | `:9457`
+`-metrics-endpoint` | `METRICS_ENDPOINT` | `/metrics`
+
+### Currently implemented metrics:
 Metric | Type | Description
 --- | --- | ---
 `nexenta_up` | gauge | Is the Nexenta API reachable (0/1)
-- 
GitLab