From 41b713ef671c376322e50eb31e712bc049fd3d28 Mon Sep 17 00:00:00 2001 From: Huan Jiang Date: Tue, 5 Apr 2022 08:53:14 -0700 Subject: [PATCH] Initial draft for project readme (#2) Signed-off-by: Huan Jiang --- README.md | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 847260c..e943a0f 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,32 @@ -## My Project + -TODO: Fill this README out! +- [Welcome!](#Dashboards Desktop) +- [Security!](#Security) +- [License!](#License) +- [Copyright](#copyright) -Be sure to: +## Dashboards Desktop -* Change the title in this README -* Edit your repository description on GitHub +Dashboards Desktop offers desktop experiene to OpenSearch Dashboards Users. OpenSearch Dashboards is an open source search and analytics visualization application. + +Dashboards Desktop provides end user *flexibility* and *extensibility* to install any Dashboards pluings they want. Dashboards Desktop could store data into local storage or cloud drive. User has full control of the data they have. + +Dashboards Desktop could be downloaded from internet. Not only deliver stable version to customer in monthly/quarterly release cadence. It will deliver experimental versions. + +Deskboards has build-in data source selector which allow user to connect to any OpenSearch endpoint they want with pre-configured credential or access key. ## Security See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information. +## Code of Conduct + +This project has adopted the [Amazon Open Source Code of Conduct](CODE_OF_CONDUCT.md). For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq), or contact [opensource-codeofconduct@amazon.com](mailto:opensource-codeofconduct@amazon.com) with any additional questions or comments. + ## License This project is licensed under the Apache-2.0 License. +## Copyright + +Copyright OpenSearch Contributors. See [NOTICE](NOTICE.txt) for details.