Skip to content

Commit bb3fd10

Browse files
committed
chore: update license and readme
1 parent 1bb43c1 commit bb3fd10

File tree

3 files changed

+81
-131
lines changed

3 files changed

+81
-131
lines changed

LICENSE.md

Lines changed: 57 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -1,80 +1,57 @@
1-
# Event Store License
2-
3-
Copyright (c) 2011-2023, Event Store LLP. All rights reserved.
4-
5-
Redistribution and use in source and binary forms, with or without
6-
modification, are permitted provided that the following conditions are met:
7-
8-
Redistributions of source code must retain the above copyright notice, this
9-
list of conditions and the following disclaimer.
10-
11-
Redistributions in binary form must reproduce the above copyright notice, this
12-
list of conditions and the following disclaimer in the documentation and/or
13-
other materials provided with the distribution.
14-
15-
Neither the name of Event Store LLP nor the names of its contributors may be
16-
used to endorse or promote products derived from this software without specific
17-
prior written permission.
18-
19-
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
20-
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21-
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22-
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
23-
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24-
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25-
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
26-
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27-
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28-
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29-
30-
# Dependencies
31-
32-
Event Store is permissively licensed under the 3-clause BSD license. We depend
33-
on several other open source projects either "as-is" or in a modified form, and
34-
credit them along with listing their licensing terms here.
35-
36-
Along with each is a note detailing the form the dependency takes. Nothing is
37-
implied by the order in which dependencies are presented here.
38-
39-
# Google Protobuf
40-
41-
Copyright 2008 Google Inc. All rights reserved.
42-
43-
Redistribution and use in source and binary forms, with or without
44-
modification, are permitted provided that the following conditions are
45-
met:
46-
47-
* Redistributions of source code must retain the above copyright
48-
notice, this list of conditions and the following disclaimer.
49-
* Redistributions in binary form must reproduce the above
50-
copyright notice, this list of conditions and the following disclaimer
51-
in the documentation and/or other materials provided with the
52-
distribution.
53-
* Neither the name of Google Inc. nor the names of its
54-
contributors may be used to endorse or promote products derived from
55-
this software without specific prior written permission.
56-
57-
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
58-
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
59-
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
60-
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
61-
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
62-
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
63-
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
64-
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
65-
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
66-
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
67-
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
68-
69-
Code generated by the Protocol Buffer compiler is owned by the owner
70-
of the input file used when generating it. This code is not
71-
standalone and requires a support library to be linked with it. This
72-
support library is itself covered by the above license.
73-
74-
# gRPC Dotnet
75-
76-
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
77-
78-
http://www.apache.org/licenses/LICENSE-2.0
79-
80-
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
1+
# Kurrent License v1
2+
3+
Copyright (c) 2011-2025, Kurrent, Inc. All rights reserved.
4+
5+
### Acceptance
6+
7+
By using the software, you agree to all of the terms and conditions below.
8+
9+
### Copyright License
10+
11+
The licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software, in each case subject to the limitations and conditions below.
12+
13+
### Limitations
14+
15+
You may not provide the software to third parties as a hosted or managed service, where the service provides users with access to any substantial set of the features or functionality of the software.
16+
17+
Unless authorized in writing by the licensor, you may not move, change, disable, interfere with, or circumvent the license mechanisms in the software, and you may not remove or obscure any functionality in the software that is protected by the license mechanisms.
18+
19+
You may not alter, remove, or obscure any licensing, copyright, or other notices of the licensor in the software. Any use of the licensor’s trademarks is subject to applicable law.
20+
21+
### Patents
22+
23+
The licensor grants you a license, under any patent claims the licensor can license, or becomes able to license, to make, have made, use, sell, offer for sale, import and have imported the software, in each case subject to the limitations and conditions in this license. This license does not cover any patent claims that you cause to be infringed by modifications or additions to the software. If you or your company make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
24+
25+
### Notices
26+
27+
You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms.
28+
29+
If you modify the software, you must include in any modified copies of the software prominent notices stating that you have modified the software.
30+
31+
### No Other Rights
32+
33+
These terms do not imply any licenses other than those expressly granted in these terms.
34+
35+
### Termination
36+
37+
If you use the software in violation of these terms, such use is not licensed, and your licenses will automatically terminate. If the licensor provides you with a notice of your violation, and you cease all violation of this license no later than 30 days after you receive that notice, your licenses will be reinstated retroactively. However, if you violate these terms after such reinstatement, any additional violation of these terms will cause your licenses to terminate automatically and permanently.
38+
39+
### No Liability
40+
41+
***As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.***
42+
43+
### Definitions
44+
45+
The **licensor** is the entity offering these terms, and the **software** is the software the licensor makes available under these terms, including any portion of it.
46+
47+
**licensing mechanisms** refers to functionality that restricts use of the software based on whether you possess a valid license key, including functionality to validate license keys and audit usage of the software to ensure license compliance.
48+
49+
**you** refers to the individual or entity agreeing to these terms.
50+
51+
**your company** is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization. **control** means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise. Control can be direct or indirect.
52+
53+
**your licenses** are all the licenses granted to you for the software under these terms.
54+
55+
**use** means anything you do with the software requiring one of your licenses.
56+
57+
**trademark** means trademarks, service marks, and similar rights.

README.md

Lines changed: 8 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,18 @@
1-
# EventStoreDB .NET Client
1+
# KurrentDB .NET Client
22

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
44

5-
This is the repository for the .NET client for EventStoreDB version 20+ and uses gRPC as the communication protocol.
6-
If you're looking for the TCP client library (legacy), check the [EventStoreDB-Client-Dotnet-Legacy](https://github.com/EventStore/EventStoreDB-Client-Dotnet-Legacy) repo.
5+
This is the repository for the .NET client for KurrentDB version 20+ and uses gRPC as the communication protocol.
76

87
## Installation
98

109
Reference the nuget package(s) for the API that you would like to call
1110

12-
[Streams](https://www.nuget.org/packages/EventStore.Client.Grpc.Streams)
13-
14-
[Operations](https://www.nuget.org/packages/EventStore.Client.Grpc.Operations)
15-
16-
[Persistent Subscriptions](https://www.nuget.org/packages/EventStore.Client.Grpc.PersistentSubscriptions)
17-
18-
[Projection Management](https://www.nuget.org/packages/EventStore.Client.Grpc.ProjectionManagement)
19-
20-
[User Management](https://www.nuget.org/packages/EventStore.Client.Grpc.UserManagement)
21-
22-
## Open Telemetry
23-
24-
Telemetry instrumentation can be enabled by installing the [Open Telemetry Extensions](https://www.nuget.org/packages/EventStore.Client.Extensions.OpenTelemetry) package.
25-
26-
Once installed you can configure instrumentation using the `AddEventStoreClientInstrumentation` extension method on a `TracerProviderBuilder`.
27-
28-
```csharp
29-
using var tracerProvider = Sdk.CreateTracerProviderBuilder()
30-
...
31-
.AddEventStoreClientInstrumentation()
32-
...
33-
.Build();
34-
```
35-
36-
Tracing is the only telemetry currently exported, specifically for the `Append` and `Subscribe` (Catchup and Persistent) operations.
37-
38-
For more information about Open Telemetry, refer to the [official documentation](https://opentelemetry.io/docs/what-is-opentelemetry/).
11+
[KurrentDB.Client](https://www.nuget.org/packages/KurrentDB.Client)
3912

4013
## Support
4114

42-
Information on support and commercial tools such as LDAP authentication can be found here: [Event Store Support](https://eventstore.com/support/).
15+
Information on support and commercial tools such as LDAP authentication can be found here: [Kurrent Support](https://kurrent.io/support/).
4316

4417
## CI Status
4518

@@ -49,14 +22,14 @@ Information on support and commercial tools such as LDAP authentication can be f
4922

5023
## Documentation
5124

52-
Documentation for EventStoreDB can be found here: [Event Store Docs](https://eventstore.com/docs/).
25+
Documentation for KurrentDB can be found here: [Kurrent Docs](https://kurrent.io/docs/).
5326

5427
Bear in mind that this client is not yet properly documented. We are working hard on a new version of the documentation.
5528

5629
## Communities
5730

58-
- [Discuss](https://discuss.eventstore.com/)
59-
- [Discord (Event Store)](https://discord.gg/Phn9pmCw3t)
31+
- [Discuss](https://discuss.kurrent.io/)
32+
- [Discord (Kurrent)](https://discord.gg/Phn9pmCw3t)
6033
- [Discord (ddd-cqrs-es)](https://discord.com/invite/sEZGSHNNbH)
6134

6235
## Contributing

samples/secure-with-tls/README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Secure EventStoreDB with TLS
1+
# Secure KurrentDB with TLS
22

3-
- [Secure EventStoreDB with TLS](#secure-eventstoredb-with-tls)
3+
- [Secure KurrentDB with TLS](#secure-kurrentdb-with-tls)
44
- [Overview](#overview)
55
- [Certificates](#certificates)
66
- [Description](#description)
@@ -10,43 +10,43 @@
1010
- [3. Run samples locally (without Docker)](#3-run-samples-locally-without-docker)
1111
- [3.1 Install certificate - Linux (Ubuntu, Debian, WSL) or MacOS](#31-install-certificate---linux-ubuntu-debian)
1212
- [3.2 Install certificate - Windows](#32-install-certificate---windows)
13-
- [3.3 Run EventStoreDB node](#33-run-eventstoredb-node)
13+
- [3.3 Run KurrentDB node](#33-run-kurrentdb-node)
1414
- [3.3 Run client application](#33-run-client-application)
1515

1616
## Overview
1717

1818
The sample shows how to run the .NET client secured by TLS certificates.
1919

2020
Read more in the docs:
21-
- [Security](https://developers.eventstore.com/server/v20/server/security/)
22-
- [Running EventStoreDB with `docker-compose`](https://developers.eventstore.com/server/v20/server/installation/docker.html#use-docker-compose)
23-
- [Event Store Certificate Generation CLI](https://github.com/EventStore/es-gencert-cli)
21+
- [Security](https://developers.kurrent.io/server/v20/server/security/)
22+
- [Running KurrentDB with `docker-compose`](https://developers.kurrent.io/server/v20/server/installation/docker.html#use-docker-compose)
23+
- [Event Store Certificate Generation CLI](https://github.com/Kurrent/es-gencert-cli)
2424

25-
It is essential for production use to configure EventStoreDB security features to prevent unauthorised access to your data.
26-
EventStoreDB supports gRPC with TLS and SSL.
25+
It is essential for production use to configure KurrentDB security features to prevent unauthorised access to your data.
26+
KurrentDB supports gRPC with TLS and SSL.
2727

2828
Each protocol has its security configuration, but you can only use one set of certificates for TLS and HTTPS.
2929

3030
### Certificates
3131

32-
The protocol security configuration depends a lot on the deployment topology and platform. We have created an interactive [configuration tool](https://github.com/EventStore/es-gencert-cli), which also has instructions on generating and installing the certificates and configure EventStoreDB nodes to use them.
32+
The protocol security configuration depends a lot on the deployment topology and platform. We have created an interactive [configuration tool](https://github.com/Kurrent/es-gencert-cli), which also has instructions on generating and installing the certificates and configure KurrentDB nodes to use them.
3333

3434
You need to generate CA (certificate authority)
3535

3636
`./es-gencert-cli create-ca -out ./es-ca`
3737

3838
And certificate for each node in your cluster.
3939

40-
`./es-gencert-cli-cli create-node -ca-certificate ./es-ca/ca.crt -ca-key ./es-ca/ca.key -out ./node -ip-addresses 127.0.0.1,172.20.240.1 -dns-names localhost,eventstoredb`
40+
`./es-gencert-cli-cli create-node -ca-certificate ./es-ca/ca.crt -ca-key ./es-ca/ca.key -out ./node -ip-addresses 127.0.0.1,172.20.240.1 -dns-names localhost,kurrentdb`
4141

4242
The client application should have public CA certificate installed (**_Note:_** private keys should not be shared to clients).
4343

4444
While generating the certificate, you need to remember to pass:
4545
- IP addresses to `-ip-addresses`: e.g. `127.0.0.1,172.20.240.1` or
46-
- DNS names to `-dns-names`: e.g. `localhost,eventstoredb`
47-
that will match the URLs that you will be accessing EventStoreDB nodes.
46+
- DNS names to `-dns-names`: e.g. `localhost,kurrentdb`
47+
that will match the URLs that you will be accessing KurrentDB nodes.
4848

49-
The [Certificate Generation CLI](https://github.com/EventStore/es-gencert-cli) is also available as the Docker image. Check the [docker-compose.certs.yml](./docker-compose.certs.yml)
49+
The [Certificate Generation CLI](https://github.com/Kurrent/es-gencert-cli) is also available as the Docker image. Check the [docker-compose.certs.yml](./docker-compose.certs.yml)
5050

5151
See instruction how to install certificates [below](#3-run-run-samples-locally-without-docker).
5252

@@ -61,7 +61,7 @@ The sample shows how to connect with the client and append new event. You can ru
6161
Suggested order of reading:
6262
- The full code is located in [Program.cs](./Program.cs) file
6363
- [Dockerfile](./Dockerfile) - for building the sample image
64-
- [docker-compose.yml](./docker-compose.yml) - for running a single EventStoreDB node.
64+
- [docker-compose.yml](./docker-compose.yml) - for running a single KurrentDB node.
6565
- [docker-compose.app.yml](./docker-compose.app.yml) - for running the sample client app.
6666
- [docker-compose.certs.yml](./docker-compose.certs.yml) - for generating certificates.
6767

@@ -90,9 +90,9 @@ docker-compose -f docker-compose.yml -f docker-compose.app.yml up
9090
### 3. Run samples locally (without Docker)
9191
Assuming the certificates were generated and installed.
9292

93-
#### 3.1 Run EventStoreDB
93+
#### 3.1 Run KurrentDB
9494

95-
Use the following command to run EventStoreDB
95+
Use the following command to run KurrentDB
9696

9797
```console
9898
docker-compose up -d

0 commit comments

Comments
 (0)