Skip to content

Commit 961df7b

Browse files
committed
doc: update readmes
1 parent 9e15b0a commit 961df7b

File tree

8 files changed

+21
-10
lines changed

8 files changed

+21
-10
lines changed

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
blank_issues_enabled: false
22
contact_links:
33
- name: Feature request
4-
url: https://discuss.eventstore.com/
4+
url: https://discuss.kurrent.io/
55
about: Suggest an idea for this project
66
- name: Question / Problem
7-
url: https://discuss.eventstore.com/
7+
url: https://discuss.kurrent.io/
88
about: Questions and problems with n8n

KurrentLogo-Black.png

41.4 KB
Loading

KurrentLogo-Plum.png

56.3 KB
Loading

KurrentLogo-White.png

43.4 KB
Loading

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
<a href="https://kurrent.io">
2+
<picture>
3+
<source media="(prefers-color-scheme: dark)" srcset="KurrentLogo-White.png">
4+
<source media="(prefers-color-scheme: light)" srcset="KurrentLogo-Black.png">
5+
<img alt="Kurrent" src="KurrentLogo-Plum.png" height="50%" width="50%">
6+
</picture>
7+
</a>
8+
19
# KurrentDB NodeJS Client
210

311
[![license][license-badge]][license-badge-url]
@@ -12,10 +20,13 @@ This monorepo contains the following packages:
1220

1321
| Subfolder | Package |
1422
| ---------------------------------------------------- | -------------------------------------------------------------------------------- |
15-
| [`packages/db-client/`](packages/db-client/) | [`@kurrent/client`](https://www.npmjs.com/package/@kurrent/db-client) |
23+
| [`packages/db-client/`](packages/db-client/) | [`@kurrent/client`](https://www.npmjs.com/package/@kurrent/kurrentdb-client) |
1624
| [`packages/opentelemetry/`](packages/opentelemetry/) | [`@kurrent/opentelemetry`](https://www.npmjs.com/package/@kurrent/opentelemetry) |
1725
| [`packages/test/`](packages/test/) | Internal tests |
1826

27+
The client uses [KurrentDB-Bridge-Client](https://github.com/EventStore/EventStore-Client-NodeJS)
28+
to significantly improve read performance by leveraging Rust through native addons.
29+
1930
## Support
2031

2132
Information on support can be found on our website: [Kurrent Support]

packages/db-client/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ Information on support can be found on our website: [Kurrent Support]
188188
Refer to our [Contribution Guidelines]
189189

190190
[Kurrent support]: https://kurrent.io/support/
191-
[discuss]: https://discuss.eventstore.com/
191+
[discuss]: https://discuss.kurrent.io/
192192
[discord-kurrent]: https://discord.gg/Phn9pmCw3t
193193
[discord-ddd-cqrs-es]: https://discord.com/invite/sEZGSHNNbH
194194
[npm-badge]: https://img.shields.io/npm/v/@kurrent/db-client.svg

packages/opentelemetry/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ npm install --save @kurrent/opentelemetry
1515

1616
### Supported Versions
1717

18-
- `[6.x]`
18+
- `[1.x]`
1919

2020
It's likely that the instrumentation would support earlier versions of KurrentDB, but this has not been tested.
2121

@@ -35,7 +35,7 @@ provider.register();
3535

3636
registerInstrumentations({
3737
instrumentations: [
38-
new EventStoreDBInstrumentation(),
38+
new KurrentDBInstrumentation(),
3939
],
4040
});
4141
```
@@ -59,13 +59,13 @@ Information on support can be found on our website: [Kurrent Support]
5959

6060
## Contributing
6161

62-
Refer to our [contribution guidelines][contributing-guidelines].
62+
Refer to our [contribution guidelines]
6363

6464
[Kurrent support]: https://kurrent.io/support/
65-
[discuss]: https://discuss.eventstore.com/
65+
[discuss]: https://discuss.kurrent.io/
6666
[discord-kurrent]: https://discord.gg/Phn9pmCw3t
6767
[Discord-ddd-cqrs-es]: https://discord.com/invite/sEZGSHNNbH
68-
[contributing-guidelines]: https://github.com/prisma/prisma/blob/main/CONTRIBUTING.md
68+
[contribution guidelines]: https://github.com/EventStore/KurrentDB-Client-NodeJS/blob/master/CONTRIBUTING.md
6969
[license-badge]: https://img.shields.io/npm/l/@kurrent/db-client.svg
7070
[license-badge-url]: https://github.com/EventStore/KurrentDB-Client-NodeJS/blob/master/LICENSE
7171
[ci-badge-url]: https://github.com/EventStore/KurrentDB-Client-NodeJS/actions

packages/test/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Information on support can be found on our website: [Kurrent Support]
1919
Refer to our [contribution guidelines][contributing-guidelines].
2020

2121
[Kurrent support]: https://kurrent.io/support/
22-
[discuss]: https://discuss.eventstore.com/
22+
[discuss]: https://discuss.kurrent.io/
2323
[discord-kurrent]: https://discord.gg/Phn9pmCw3t
2424
[discord-ddd-cqrs-es]: https://discord.com/invite/sEZGSHNNbH
2525
[contributing-guidelines]: https://github.com/prisma/prisma/blob/main/CONTRIBUTING.md

0 commit comments

Comments
 (0)