[![Build](https://github.com/opensearch-project/opensearch-net/actions/workflows/compile.yml/badge.svg)](https://github.com/opensearch-project/opensearch-net/actions/workflows/compile.yml)
[![Unit Tests](https://github.com/opensearch-project/opensearch-net/actions/workflows/test-jobs.yml/badge.svg)](https://github.com/opensearch-project/opensearch-net/actions/workflows/test-jobs.yml)
[![Integration Tests](https://github.com/opensearch-project/opensearch-net/actions/workflows/integration.yml/badge.svg)](https://github.com/opensearch-project/opensearch-net/actions/workflows/integration.yml)
[![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)](https://github.com/opensearch-project/opensearch-net/compare)

![OpenSearch logo](OpenSearch.svg)

- [OpenSearch .NET Client](#opensearch-net-client)
  - [Welcome!](#welcome)
  - [Project Resources](#project-resources)
  - [OpenSearch.Client](#opensearch-client)
  - [Getting Started](#getting-started)
  - [Compatibility with OpenSearch](#compatibility-with-opensearch)
  - [Code of Conduct](#code-of-conduct)
  - [License](#license)
  - [Copyright](#copyright)

# OpenSearch .NET Client

## Welcome!

**opensearch-net** is [a community-driven, open source fork](https://aws.amazon.com/blogs/opensource/introducing-opensearch/) of elasticsearch-net licensed under the [Apache v2.0 License](LICENSE.txt). For more information, see [opensearch.org](https://opensearch.org/).

**OpenSearch.Client** is [a community-driven, open source fork](https://aws.amazon.com/blogs/opensource/introducing-opensearch/) of elasticsearch-net high level client NEST licensed under the [Apache v2.0 License](LICENSE.txt). For more information, see [opensearch.org](https://opensearch.org/).

## Project Resources

* [Project Website](https://opensearch.org/)
* [Downloads](https://opensearch.org/downloads.html)
* [Documentation](https://opensearch.org/docs/latest/clients/dot-net/)
* Need help? Try [Forums](https://discuss.opendistrocommunity.dev/)
* [Project Principles](https://opensearch.org/#principles)
* [Contributing to OpenSearch](CONTRIBUTING.md)
* [Maintainer Responsibilities](MAINTAINERS.md)
* [Release Management](RELEASING.md)
* [Admin Responsibilities](ADMINS.md)
* [Security](SECURITY.md)

## [OpenSearch.Client](https://github.com/opensearch-project/opensearch-net/tree/main/src/OpenSearch.Client)

OpenSearch.Client is the official high-level .NET client of [OpenSearch](https://github.com/opensearch-project/OpenSearch).

## Getting Started

See [USER_GUIDE](USER_GUIDE.md) to get started with the .NET client.

## Compatibility with OpenSearch

See [COMPATIBILITY](COMPATIBILITY.md).

## 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 v2.0 License](LICENSE.txt).

## Copyright

Copyright OpenSearch Contributors. See [NOTICE](./NOTICE.txt) for details.