Skip to content

Commit fed933b

Browse files
committed
Udpate readme for the beta release
1 parent 031453f commit fed933b

File tree

1 file changed

+7
-24
lines changed

1 file changed

+7
-24
lines changed

README.md

Lines changed: 7 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The official Java client for [Elasticsearch](https://github.com/elastic/elastics
66

77
---
88

9-
**Note: this project is still a work in progress.** This client is meant to replace the existing [Java High Level Client](https://www.elastic.co/guide/en/elasticsearch/client/java-rest/master/java-rest-high.html) and remove all dependencies to the Elasticsearch server code base.
9+
**Note: this project is still in beta.** This client is meant to replace the existing [Java High Level Client](https://www.elastic.co/guide/en/elasticsearch/client/java-rest/master/java-rest-high.html) and remove all dependencies to the Elasticsearch server code base.
1010

1111
---
1212

@@ -26,21 +26,13 @@ This library requires at least Java 8.
2626

2727
Along with this library, you also need a JSON/object mapping library. `elasticsearch-java` has built-in support for [Jackson](https://github.com/FasterXML/jackson) and [JSON-B](http://json-b.net/) implementations such as [Eclipse Yasson](https://github.com/eclipse-ee4j/yasson).
2828

29-
While it's a work in progress, snapshots of this library are published to Elastic's snapshot repository. Snapshots are currently available for the upcoming version 7.15.0, built from the `7.x` branch.
29+
Releases are hosted on [Maven Central](https://search.maven.org/search?q=g:co.elastic.clients). If you are looking for a SNAPSHOT version, the Elastic Maven Snapshot repository is available at https://snapshots.elastic.co/maven/.
3030

3131
Gradle project (Groovy flavor) setup using Jackson:
3232

3333
```groovy
34-
repositories {
35-
mavenCentral()
36-
maven {
37-
name = "Elastic-Snapshots"
38-
url = uri("https://snapshots.elastic.co/maven")
39-
}
40-
}
41-
4234
dependencies {
43-
implementation 'co.elastic.clients:elasticsearch-java:7.15.0-SNAPSHOT'
35+
implementation 'co.elastic.clients:elasticsearch-java:7.15.0'
4436
implementation 'com.fasterxml.jackson.core:jackson-databind:2.12.3'
4537
}
4638
```
@@ -49,22 +41,11 @@ In the `pom.xml` for your project add the following repository definition and de
4941

5042
```xml
5143
<project>
52-
53-
<repositories>
54-
<repository>
55-
<id>Elastic-Snapshots</id>
56-
<url>https://snapshots.elastic.co/maven</url>
57-
<snapshots>
58-
<enabled>true</enabled>
59-
</snapshots>
60-
</repository>
61-
</repositories>
62-
6344
<dependencies>
6445
<dependency>
6546
<groupId>co.elastic.clients</groupId>
6647
<artifactId>elasticsearch-java</artifactId>
67-
<version>7.15.0-SNAPSHOT</version>
48+
<version>7.15.0</version>
6849
</dependency>
6950
<dependency>
7051
<groupId>com.fasterxml.jackson.core</groupId>
@@ -111,7 +92,9 @@ The Elasticsearch Java client is forward compatible; meaning that the client sup
11192

11293
## Current status
11394

114-
While not complete, this library is already fairly usable. What's missing falls in two main categories, related to the [Elasticsearch specification](https://github.com/elastic/elasticsearch-specification):
95+
Beta state means we don't expect large architectural changes and the library is already fairly usable. This library also essentially deals with request & response serialization & deserialization and delegates all http request processing to the battle-tested [Low Level Rest Client](https://www.elastic.co/guide/en/elasticsearch/client/java-rest/master/java-rest-low.html).
96+
97+
What's missing falls in two main categories, related to the [Elasticsearch specification](https://github.com/elastic/elasticsearch-specification):
11598
* incomplete support for some data types used in specification (e.g. unions). Until they have been implemented in the code generator, they are represented as raw `JsonValue` objects.
11699
* incomplete APIs: as the API specification is still incomplete, so are their implementations in this library since their code is entirely generated from the spec.
117100

0 commit comments

Comments
 (0)