Skip to content

Commit 7d7778e

Browse files
committed
[DOCS] Resolves conflict.
1 parent 431770e commit 7d7778e

File tree

2 files changed

+60
-11
lines changed

2 files changed

+60
-11
lines changed

README.md

Lines changed: 59 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,75 @@
11
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**.*
22

3-
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.).
3+
The .NET client for Elasticsearch provides strongly typed requests and responses
4+
for Elasticsearch APIs. It delegates protocol handling to the
5+
[Elastic.Transport](https://github.com/elastic/elastic-transport-net) library,
6+
which takes care of all transport-level concerns (HTTP connection establishment
7+
and pooling, retries, etc.).
48

59
## Compatibility
610

7-
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.
11+
Language clients are forward compatible; meaning that clients support
12+
communicating with greater or equal minor versions of Elasticsearch.
13+
Elasticsearch language clients are only backwards compatible with default
14+
distributions and without guarantees made.
15+
16+
## Installation
17+
18+
Refer to the [Installation section](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/getting-started-net.html#_installation)
19+
of the getting started documentation.
20+
21+
## Connecting
22+
23+
Refer to the [Connecting section](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/getting-started-net.html#_connecting)
24+
of the getting started documentation.
25+
26+
## Usage
27+
28+
- [Creating an index](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/getting-started-net.html#_creating_an_index)
29+
- [Indexing a document](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/getting-started-net.html#_indexing_documents)
30+
- [Getting documents](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/getting-started-net.html#_getting_documents)
31+
- [Searching documents](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/getting-started-net.html#_searching_documents)
32+
- [Updating documents](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/getting-started-net.html#_updating_documents)
33+
- [Deleting documents](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/getting-started-net.html#_deleting_documents)
34+
- [Deleting an index](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/getting-started-net.html#_deleting_an_index)
35+
36+
## Documentation
37+
38+
Please refer to
39+
[the full documentation on elastic.co](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/index.html)
40+
for comprehensive information on installation, configuration and usage.
841

942
## Versions
1043

1144
### Elasticsearch 8.x Clusters
1245

46+
<<<<<<< HEAD
1347
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
1448
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.
15-
16-
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.
49+
=======
50+
We have released the next generation of the .NET client for Elasticsearch, which
51+
aligns with v8 of Elasticsearch. We have renamed this library
52+
`Elastic.Clients.Elasticsearch`, and the packages are published on
53+
[NuGet](https://www.nuget.org/packages/Elastic.Clients.Elasticsearch/). The
54+
8.0.x versions do not offer complete feature parity with the existing `NEST`
55+
client. We therefore recommend you thoroughly review our
56+
[release notes and migration guidance](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/release-notes-8.0.0.html)
57+
before attempting to migrate existing applications to the
58+
`Elastic.Clients.Elasticsearch` library.
59+
>>>>>>> c60cdc56f6 ([DOCS] Restructures repo README. (#7843))
60+
61+
Until the new client supports all endpoints and features your application
62+
requires, you may continue to use the latest `7.17.x` client to communicate with
63+
Elasticsearch v8 servers. Please review
64+
[our documentation](https://www.elastic.co/guide/en/elasticsearch/client/net-api/7.17/connecting-to-elasticsearch-v8.html),
65+
which describes how to enable compatibility mode and secure communications with
66+
a v8 cluster.
1767

1868
### Elasticsearch 7.x Clusters
1969

20-
We recommend using the latest `7.17.x` [NEST client](https://www.nuget.org/packages/Nest) to communicate with Elasticsearch v7 servers.
21-
22-
## Documentation
23-
24-
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.
70+
We recommend using the latest `7.17.x`
71+
[NEST client](https://www.nuget.org/packages/Nest) to communicate with
72+
Elasticsearch v7 servers.
2573

2674
## Contributing
2775

@@ -31,4 +79,5 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md)
3179

3280
This software is Copyright (c) 2014-2022 by Elasticsearch BV.
3381

34-
This is free software, licensed under [The Apache License Version 2.0](https://github.com/elastic/elasticsearch-net/blob/main/LICENSE.txt).
82+
This is free software, licensed under
83+
[The Apache License Version 2.0](https://github.com/elastic/elasticsearch-net/blob/main/LICENSE.txt).

docs/getting-started.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ operations with it.
88
[discrete]
99
=== Requirements
1010

11-
.NET Core, .NET 5+ or .NET Framework (4.6.1 and higher).
11+
* .NET Core, .NET 5+ or .NET Framework (4.6.1 and higher).
1212

1313
[discrete]
1414
=== Installation

0 commit comments

Comments
 (0)