github.com/opensearch-project/opensearch-go/v2@v2.3.0/README.md (about)

     1  [![Go Reference](https://pkg.go.dev/badge/github.com/opensearch-project/opensearch-go.svg)](https://pkg.go.dev/github.com/opensearch-project/opensearch-go/v2) [![Build](https://github.com/opensearch-project/opensearch-go/actions/workflows/lint.yml/badge.svg)](https://github.com/opensearch-project/opensearch-go/actions/workflows/lint.yml) [![Unit](https://github.com/opensearch-project/opensearch-go/actions/workflows/test-unit.yml/badge.svg)](https://github.com/opensearch-project/opensearch-go/actions/workflows/test-unit.yml) [![Integration](https://github.com/opensearch-project/opensearch-go/actions/workflows/test-integration.yml/badge.svg)](https://github.com/opensearch-project/opensearch-go/actions/workflows/test-integration.yml) [![codecov](https://codecov.io/gh/opensearch-project/opensearch-go/branch/main/graph/badge.svg?token=MI9g3KYHVx)](https://codecov.io/gh/opensearch-project/opensearch-go) [![Chat](https://img.shields.io/badge/chat-on%20forums-blue)](https://discuss.opendistrocommunity.dev/c/clients/) ![PRs welcome!](https://img.shields.io/badge/PRs-welcome!-success)
     2  
     3  ![OpenSearch logo](OpenSearch.svg)
     4  
     5  OpenSearch Go Client
     6  
     7  - [Welcome!](#welcome)
     8  - [Project Resources](#project-resources)
     9  - [Code of Conduct](#code-of-conduct)
    10  - [License](#license)
    11  - [Copyright](#copyright)
    12  
    13  ## Welcome!
    14  
    15  **opensearch-go** is [a community-driven, open source fork](https://aws.amazon.com/blogs/opensource/introducing-opensearch/) of go-elasticsearch licensed under the [Apache v2.0 License](LICENSE.txt). For more information, see [opensearch.org](https://opensearch.org/).
    16  
    17  ## Project Resources
    18  
    19  - [Project Website](https://opensearch.org/)
    20  - [Developer Guide](DEVELOPER_GUIDE.md)
    21  - [User Guide](USER_GUIDE.md)
    22  - [Documentation](https://opensearch.org/docs/latest/clients/go/)
    23  - [API Documentation](https://pkg.go.dev/github.com/opensearch-project/opensearch-go/v2)
    24  - Need help? Try [Forums](https://discuss.opendistrocommunity.dev/c/clients/)
    25  - [Project Principles](https://opensearch.org/#principles)
    26  - [Contributing to OpenSearch](CONTRIBUTING.md)
    27  - [Maintainer Responsibilities](MAINTAINERS.md)
    28  - [Release Management](RELEASING.md)
    29  - [Admin Responsibilities](ADMINS.md)
    30  - [Security](SECURITY.md)
    31  
    32  ## Code of Conduct
    33  
    34  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.
    35  
    36  ## License
    37  
    38  This project is licensed under the [Apache v2.0 License](LICENSE.txt).
    39  
    40  ## Copyright
    41  
    42  Copyright OpenSearch Contributors. See [NOTICE](NOTICE.txt) for details.