Merge pull request #13 from siscale/updating-readme

Updating readme

README.md

@@ -1,8 +1,36 @@
-# Arcanna Kibana Plugin
+# The ARCANNA Kibana Plugin
+
+![Arcanna](./docs/resources/readme_banner.png)
+
+Arcanna - **A**utomated **R**oot **C**ause **A**nalysis **N**eural **N**etwork **A**ssisted - is a custom built Elastic plugin capable of identifying with increased accuracy the probable root cause of issues that arise within the entire infrastructure stack. For a more in-depth description of the product, please visit [our website](https://www.siscale.com/arcanna/) and our blog postings ([#1](https://www.siscale.com/arcanna-explained-part-i-event-clustering/), [#2](https://www.siscale.com/arcanna-explained-part-ii-probable-root-cause-determination/), [#3](https://www.siscale.com/arcanna-explained-part-iii-user-feedback/)).
+
+This repository represents the Kibana plugin (UI) of the solution.
+
+In order to use the solution, you also need to setup the solution backend, which can be found [here](https://github.com/siscale/arcanna).
 
 ---
 
-## development
+## Installation
+
+In order to install the Arcanna Kibana Plugin, first download the appropriate release for your Kibana version from the [releases tab](https://github.com/siscale/kibana-arcanna/releases).
+
+To install the plugin in Kibana, run the following command:
+```
+bin/kibana-plugin install file:///PATH_TO_FILE/arcanna-vXXXXX.zip
+```
+Wait until the installation finishes. It may take several minutes to optimize and cache browser bundles.
+
+In `kibana.yml`, add the [Arcanna backend](https://github.com/siscale/arcanna) settings:
+```
+arcanna.endpoint.url: "http://ARCANNA_BACKEND_HOST:5000"
+arcanna.endpoint.token: "ARCANNA_BACKEND_AUTH_TOKEN"
+```
+
+Restart Kibana to apply the changes.
+
+You are now ready to use the Arcanna plugin.
+
+## Development
 
 See the [kibana contributing guide](https://github.com/elastic/kibana/blob/master/CONTRIBUTING.md) for instructions setting up your development environment. Once you have completed that, use the following yarn scripts.