diff --git a/README.md b/README.md index dcba0ef3d99..baba08d5f07 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,70 @@ Repository for **Elastic.Clients.Elasticsearch** the official .NET client for [Elasticsearch](https://github.com/elastic/elasticsearch). *Older branches include both previous clients, **NEST** and **Elasticsearch.Net**.* -The .NET client for Elasticsearch provides strongly typed requests and responses for Elasticsearch APIs. It delegates protocol handling to the [Elastic.Transport](https://github.com/elastic/elastic-transport-net) library, which takes care of all transport-level concerns (HTTP connection establishment and pooling, retries, etc.). +The .NET client for Elasticsearch provides strongly typed requests and responses + for Elasticsearch APIs. It delegates protocol handling to the + [Elastic.Transport](https://github.com/elastic/elastic-transport-net) library, + which takes care of all transport-level concerns (HTTP connection establishment + and pooling, retries, etc.). ## Compatibility -Language clients are forward compatible; meaning that clients support communicating with greater or equal minor versions of Elasticsearch. Elasticsearch language clients are only backwards compatible with default distributions and without guarantees made. +Language clients are forward compatible; meaning that clients support +communicating with greater or equal minor versions of Elasticsearch. +Elasticsearch language clients are only backwards compatible with default +distributions and without guarantees made. -## Versions +## Installation -### Elasticsearch 8.x Clusters +Refer to the [Installation section](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/getting-started-net.html#_installation) +of the getting started documentation. -We have released the next generation of the .NET client for Elasticsearch, which aligns with v8 of Elasticsearch. We have renamed this library `Elastic.Clients.Elasticsearch`, and the packages are published on [NuGet](https://www.nuget.org/packages/Elastic.Clients.Elasticsearch/). The 8.0.x versions do not offer complete -feature parity with the exitsing `NEST` client. We therefore recommend you thoroughly review our [release notes and migration guidance](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/release-notes-8.0.0.html) before attempting to migrate existing applications to the `Elastic.Clients.Elasticsearch` library. +## Connecting -Until the new client supports all endpoints and features your application requires, you may continue to use the latest `7.17.x` client to communicate with Elasticsearch v8 servers. Please review [our documentation](https://www.elastic.co/guide/en/elasticsearch/client/net-api/7.17/connecting-to-elasticsearch-v8.html), which describes how to enable compatibility mode and secure communications with a v8 cluster. +Refer to the [Connecting section](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/getting-started-net.html#_connecting) +of the getting started documentation. -### Elasticsearch 7.x Clusters +## Usage -We recommend using the latest `7.17.x` [NEST client](https://www.nuget.org/packages/Nest) to communicate with Elasticsearch v7 servers. +- [Creating an index](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/getting-started-net.html#_creating_an_index) +- [Indexing a document](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/getting-started-net.html#_indexing_documents) +- [Getting documents](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/getting-started-net.html#_getting_documents) +- [Searching documents](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/getting-started-net.html#_searching_documents) +- [Updating documents](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/getting-started-net.html#_updating_documents) +- [Deleting documents](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/getting-started-net.html#_deleting_documents) +- [Deleting an index](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/getting-started-net.html#_deleting_an_index) ## Documentation -Please refer to [the full documentation on elastic.co](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/index.html) for comprehensive information on installation, configuration and usage. +Please refer to +[the full documentation on elastic.co](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/index.html) +for comprehensive information on installation, configuration and usage. + +## Versions + +### Elasticsearch 8.x Clusters + +We have released the next generation of the .NET client for Elasticsearch, which +aligns with v8 of Elasticsearch. We have renamed this library +`Elastic.Clients.Elasticsearch`, and the packages are published on +[NuGet](https://www.nuget.org/packages/Elastic.Clients.Elasticsearch/). The +8.0.x versions do not offer complete feature parity with the existing `NEST` +client. We therefore recommend you thoroughly review our +[release notes and migration guidance](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/release-notes-8.0.0.html) +before attempting to migrate existing applications to the +`Elastic.Clients.Elasticsearch` library. + +Until the new client supports all endpoints and features your application +requires, you may continue to use the latest `7.17.x` client to communicate with +Elasticsearch v8 servers. Please review +[our documentation](https://www.elastic.co/guide/en/elasticsearch/client/net-api/7.17/connecting-to-elasticsearch-v8.html), +which describes how to enable compatibility mode and secure communications with +a v8 cluster. + +### Elasticsearch 7.x Clusters + +We recommend using the latest `7.17.x` +[NEST client](https://www.nuget.org/packages/Nest) to communicate with +Elasticsearch v7 servers. ## Contributing @@ -31,4 +74,5 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md) This software is Copyright (c) 2014-2022 by Elasticsearch BV. -This is free software, licensed under [The Apache License Version 2.0](https://github.com/elastic/elasticsearch-net/blob/main/LICENSE.txt). \ No newline at end of file +This is free software, licensed under +[The Apache License Version 2.0](https://github.com/elastic/elasticsearch-net/blob/main/LICENSE.txt). \ No newline at end of file diff --git a/docs/getting-started.asciidoc b/docs/getting-started.asciidoc index ef07a698128..da72fc96d51 100644 --- a/docs/getting-started.asciidoc +++ b/docs/getting-started.asciidoc @@ -8,7 +8,7 @@ operations with it. [discrete] === Requirements -.NET Core, .NET 5+ or .NET Framework (4.6.1 and higher). +* .NET Core, .NET 5+ or .NET Framework (4.6.1 and higher). [discrete] === Installation