readme

gree-gorey · Jul 6, 2018 · 7ce82b6 · 7ce82b6
1 parent beda27f
commit 7ce82b6
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -10,3 +10,6 @@
 
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
+
+cmd/bash-exporter/bash-exporter
+cmd/bash-exporter/*.sh
diff --git a/README.md b/README.md
@@ -1,2 +1,20 @@
 # bash-exporter
+
 Prometheus exporter for bash scripts
+
+```console
+Usage of ./bash-exporter:
+  -debug
+    	Debug log level
+  -interval int
+    	Interval for metrics collection in seconds (default 300)
+  -path string
+    	path to script (default "/usr/local/bash-exporter/run.sh")
+  -prefix string
+    	Prefix for metrics (default "bash")
+  -web.listen-address string
+    	Address on which to expose metrics (default ":9300")
+```
+
+## TODO
+- [ ] Docker image