From 78d8879e44d8fd196f44c99cf86632ce00e408d0 Mon Sep 17 00:00:00 2001 From: Zhongnan Su Date: Thu, 7 May 2020 19:15:38 -0700 Subject: [PATCH] added CONTRIBUTOR.md --- CONTRIBUTORS.md | 5 +++++ README.md | 2 +- development_guide.md | 5 +++-- 3 files changed, 9 insertions(+), 3 deletions(-) create mode 100644 CONTRIBUTORS.md diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md new file mode 100644 index 0000000..af256f0 --- /dev/null +++ b/CONTRIBUTORS.md @@ -0,0 +1,5 @@ +Contributors in order of last name: + +Abbas Hussain + +Zhongnan Su \ No newline at end of file diff --git a/README.md b/README.md index 56c5d86..1c10cea 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Open Distro for Elasticsearch SQL CLI The SQL CLI component in Open Distro for Elasticsearch (ODFE) is a stand-alone Python application and can be launched by a 'wake' word `odfesql`. It serves as a support only for -[Open Distro SQL plugin for Elasticsearch](https://opendistro.github.io/for-elasticsearch-docs/docs/sql/). User must have the ODFE SQL plugin installed to your Elasticsearch instance to connect. Users can run this CLI from MacOS and Linux, and connect to any valid Elasticsearch end-point such as Amazon Elasticsearch. +[Open Distro SQL plugin for Elasticsearch](https://opendistro.github.io/for-elasticsearch-docs/docs/sql/). User must have the ODFE SQL plugin installed to your Elasticsearch instance to connect. Users can run this CLI from MacOS and Linux, and connect to any valid Elasticsearch end-point such as Amazon Elasticsearch. ## Installation - `pip install odfesql` diff --git a/development_guide.md b/development_guide.md index 9e42259..cf39213 100644 --- a/development_guide.md +++ b/development_guide.md @@ -8,8 +8,9 @@ ### Run CLI - Start an Elasticsearch instance from either local, Docker with Open Distro SQL plugin, or AWS Elasticsearch -- To launch the cli, use wake word `odfesql` followed by endpoint of your running ES instance. If not specifying -any endpoint, it uses http://localhost:9200 by default. +- To launch the cli, use 'wake' word `odfesql` followed by endpoint of your running ES instance. If not specifying +any endpoint, it uses http://localhost:9200 by default. If not provided with port number, http endpoint uses 9200 and +https uses 443 by default. ### Testing - Prerequisites