Added screenshots to README.

bitsensor · May 19, 2016 · 3ee2eba · 3ee2eba
1 parent e9c6846
commit 3ee2eba
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,34 @@
-# kibana-swimlane-vis
-Kibana 4 swimlane visualization
+# Swimlane visualization for Kibana
+
+A swimlane visualization for Kibana 4.
+
+The visualization displays the behavior of a metric value over time across a field from the results.
+Each lane displays a different value of the selected field, with the relative size of the metric
+for that field over each time indicated by the color of the symbol at that time.
+
+![image](resources/screenshot.png)
+
+![image](resources/visualization.png)
+
+## Compatibility
+
+This plugin has been tested with Kibana versions 4.3, 4.4 and 4.5.
+
+## Installation
+
+### Automatic
+
+```
+./bin/kibana plugin -i prelert_swimlane_vis -u https://github.com/prelert/kibana-swimlane-vis/archive/v0.1.0.zip
+```
+
+## Options
+
+![image](resources/options.png)
+
+## Issues
+Please file issues [here](https://github.com/prelert/kibana-swimlane-vis/issues).
+
+
+
+
diff --git a/resources/options.png b/resources/options.png
diff --git a/resources/screenshot.png b/resources/screenshot.png
diff --git a/resources/visualization.png b/resources/visualization.png