Skip to content
This repository has been archived by the owner on Mar 31, 2021. It is now read-only.

Commit

Permalink
Update README.md (#71)
Browse files Browse the repository at this point in the history
* Update README.md

* Update README.md
  • Loading branch information
anirudha authored May 21, 2020
1 parent 7323a36 commit 68e16df
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Open Distro for Elasticsearch SQL Kibana plugin
# Open Distro for Elasticsearch
Workbench

The Open Distro for Elasticsearch SQL Kibana plugin enables you to query your Elasticsearch data using SQL syntax from a dedicated Kibana UI. You can download your query results data in JSON, JDBC, CSV and raw text formats.
The Open Distro for Elasticsearch SQL Workbench enables you to query your Elasticsearch data using SQL syntax from a dedicated Kibana UI. You can download your query results data in JSON, JDBC, CSV and raw text formats.


## Documentation
Expand Down Expand Up @@ -35,7 +36,7 @@ Ultimately, your directory structure should look like this:

To build the plugin's distributable zip simply run `yarn build`.

Example output: `./build/sql-kibana-1.4.0.0.zip`
Example output: `./build/sql-workbench-*.zip`


## Run
Expand All @@ -49,14 +50,14 @@ Example output: `./build/sql-kibana-1.4.0.0.zip`
Runs the plugin tests.


## Contributing to Open Distro for Elasticsearch SQL Kibana
## Contributing to Open Distro for Elasticsearch SQL Workbench

- Refer to [CONTRIBUTING.md](./CONTRIBUTING.md).
- Since this is a Kibana plugin, it can be useful to review the [Kibana contributing guide](https://github.com/elastic/kibana/blob/master/CONTRIBUTING.md) alongside the documentation around [Kibana plugins](https://www.elastic.co/guide/en/kibana/master/kibana-plugins.html) and [plugin development](https://www.elastic.co/guide/en/kibana/master/plugin-development.html).
- Since this is a Workbench, it can be useful to review the [Kibana contributing guide](https://github.com/elastic/kibana/blob/master/CONTRIBUTING.md) alongside the documentation around [Workbenchs](https://www.elastic.co/guide/en/kibana/master/kibana-plugins.html) and [plugin development](https://www.elastic.co/guide/en/kibana/master/plugin-development.html).

## Bugs, Enhancements or Questions

Please file an issue to report any bugs you may find, enhancements you may need or questions you may have [here](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/issues).
Please file an issue to report any bugs you may find, enhancements you may need or questions you may have [here](https://github.com/opendistro-for-elasticsearch/sql-workbench/issues).

## License

Expand Down

0 comments on commit 68e16df

Please sign in to comment.