You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
#Contributing to`EventStoreDB-Client-Java`
1
+
#Contributing to`Kurrent-Client-Java`
2
2
3
3
Welcome to the Event Store community, and thank you for contributing! The following guide outlines the basics of how to get involved. Pull requests to update and expand this guide are very welcome!
4
4
@@ -10,7 +10,7 @@ We want the Event Store community to be as welcoming and inclusive as possible,
10
10
11
11
###Licensing
12
12
13
-
`EventStoreDB-Client-Java` is licensed under the[Apache-2.0][apache2] license. By submitting a pull request, you represent that you have right to license your contribution to Event Store Ltd and the community, and that by submitting a patch your contributions are licensed under the Apache-2.0 license.
13
+
`Kurrent-Client-Java` is licensed under the[Apache-2.0][apache2] license. By submitting a pull request, you represent that you have right to license your contribution to Event Store Ltd and the community, and that by submitting a patch your contributions are licensed under the Apache-2.0 license.
14
14
15
15
##Contributing
16
16
@@ -22,7 +22,7 @@ Please disclose issues which you believe to be a security threat _by e-mail_ to
22
22
23
23
Issues may be reported via the[GitHub Repository][github-repo]. When reporting issues, please ensure that you include relevant information which can help diagnose the problem. This includes:
24
24
25
-
- The version of`EventStoreDB-Client-Java` - including a commit SHA if using a local build
25
+
- The version of`Kurrent-Client-Java` - including a commit SHA if using a local build
26
26
27
27
- The operating system on which the issue is exhibited (on Unix, the output of`uname -a`)
28
28
@@ -47,8 +47,8 @@ Please ensure that the following steps have been undertaken before marking pull
47
47
- Ensure that commits are atomic units of work, and that the message follows our[Commit Message Template][commit-template]. A good way to do this is to configure your local clone of the repository to use our included template, by running:`git config commit.template .git.commit.template` in the root directory of the clone.
Copy file name to clipboardExpand all lines: README.md
+33-35Lines changed: 33 additions & 35 deletions
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,15 @@
1
-
#EventStoreDB Client SDK for Java
1
+
#KurrentDB Client SDK for Java
2
2
3
-
EventStoreDB is the event-native database, where business events are immutably stored and streamed. Designed for event-sourced, event-driven, and microservices architectures.
3
+
KurrentDB is the event-native database, where business events are immutably stored and streamed. Designed for event-sourced, event-driven, and microservices architectures.
4
4
5
-
This repository contains an[EventStoreDB][es] Client SDK written in Java for use with languages on the JVM. It is
5
+
This repository contains an[KurrentDB][kurrent] Client SDK written in Java for use with languages on the JVM. It is
6
6
compatible with Java 8 and above.
7
7
8
8
*Note: This client is currently under active development and further API changes are expected. Feedback is very welcome.*
9
9
10
10
##Documentation
11
-
* General documentation can be found in[Event Store GRPC Docs].
12
-
* The latest stable version Javadoc can be found here:https://eventstore.github.io/EventStoreDB-Client-Java
11
+
* General documentation can be found in[Kurrent GRPC Docs].
12
+
* The latest stable version Javadoc can be found here:https://kurrent.github.io/Kurrent-Client-Java
13
13
14
14
##Access to binaries
15
15
EventStore Ltd publishes GA (general availability) versions to[Maven Central].
@@ -31,22 +31,21 @@ repositories {
31
31
32
32
##Developing
33
33
34
-
The SDK is built using[`Gradle`][gradle]. Integration tests run against a server using Docker, with the[EventStoreDB gRPC
35
-
Client Test Container][container].
34
+
The SDK is built using[`Gradle`][gradle]. Integration tests run against a server using Docker.
36
35
37
36
###Run tests
38
37
39
38
Tests are written using[TestContainers](https://www.testcontainers.org/) and require[Docker](https://www.docker.com/) to be installed.
40
39
41
-
Specific docker images can be specified via theenviroment variable`EVENTSTORE_IMAGE`.
40
+
Specific docker images can be specified via theenvironment variable`EVENTSTORE_IMAGE`.
42
41
43
42
##Open Telemetry
44
43
45
44
Tracing is the only telemetry currently exported, specifically for the`Append` and`Subscribe` (Catchup and Persistent) operations.
46
45
47
46
For more information about Open Telemetry, refer to the[official documentation](https://opentelemetry.io/docs/what-is-opentelemetry/).
48
47
49
-
##EventStoreDB Server Compatibility
48
+
##KurrentDB Server Compatibility
50
49
51
50
This client is compatible with version`20.6.1` upwards.
52
51
@@ -56,7 +55,7 @@ Server setup instructions can be found in the [docs], follow the docker setup fo
56
55
57
56
The following snippet showcases a simple example where we form a connection, then write and read events from the server.
58
57
59
-
Note: If testing locally using`--insecure` the url should be`esdb://localhost:2113?tls=false`.
58
+
Note: If testing locally using`--insecure` the url should be`kurrentdb://localhost:2113?tls=false`.
For further details please see[the projection management tests](src/test/java/com/eventstore/dbclient/ProjectionManagementTests.java).
167
+
For further details please see[the projection management tests](src/test/java/io/kurrent/dbclient/ProjectionManagementTests.java).
169
168
170
169
##Support
171
170
172
-
Information on support can be found on our website:[Event Store Support][support]
171
+
Information on support can be found on our website:[Kurrent Support][support]
173
172
174
173
##Documentation
175
174
176
-
Documentation forEventStoreDB can be found in the[docs].
175
+
Documentation forKurrentDB can be found in the[docs].
177
176
178
177
Bear in mind that this client is not yet properly documented. We are working hard on a new version of the documentation.
179
178
180
179
##Security
181
180
182
-
If you find a vulnerability in our software, please contact us. You can find how to reach out us and report it athttps://www.eventstore.com/security#security
181
+
If you find a vulnerability in our software, please contact us. You can find how to reach out us and report it athttps://www.kurrent.io/security#security