Skip to content

Commit 9500cc6

Browse files
committed
chore: fix readme
1 parent d268447 commit 9500cc6

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

packages/devtools/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ In order to create a plugin for TanStack Devtools, you can use the `plugins` arg
2727
import { TanStackDevtoolsCore } from '@tanstack/devtools'
2828

2929
const devtools = new TanStackDevtoolsCore({
30-
options: {
31-
// your options here
30+
config: {
31+
// your config here
3232
},
3333
plugins: [
3434
{

packages/event-bus-client/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ This package is still under active development and might have breaking changes i
55
## General Usage
66

77
```tsx
8-
import { TanstackDevtoolsEventSubscription } from '@tanstack/devtools-event-bus-plugin'
8+
import { EventClient } from '@tanstack/devtools-event-client'
99

1010
interface EventMap {
1111
'query-devtools:a': { foo: string }
1212
'query-devtools:b': { foo: number }
1313
}
1414

15-
class QueryDevtoolsPlugin extends TanstackDevtoolsEventSubscription<EventMap> {
15+
class QueryDevtoolsPlugin extends EventClient<EventMap> {
1616
constructor() {
1717
super({
1818
pluginId: 'query-devtools',
@@ -34,6 +34,6 @@ plugin.on('b', (e) => {
3434

3535
## Understanding the implementation
3636

37-
The `TanstackDevtoolsEventSubscription` class is a base class for creating plugins that can subscribe to events in the Tanstack Devtools event bus. It allows you to define a set of events and their corresponding data schemas using a standard-schema based schemas.
37+
The `EventClient` class is a base class for creating plugins that can subscribe to events in the Tanstack Devtools event bus. It allows you to define a set of events and their corresponding data schemas using a standard-schema based schemas.
3838

3939
It will work on both the client/server side and all you have to worry about is emitting/listening to events.

packages/event-bus/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ This package is still under active development and might have breaking changes i
77
### Server Event Bus
88

99
```tsx
10-
import { TanstackDevtoolsServerEventBus } from '@tanstack/devtools-event-bus/server'
10+
import { ServerEventBus } from '@tanstack/devtools-event-bus/server'
1111
// Start the server event bus
12-
const devtoolsServer = new TanstackDevtoolsServerEventBus()
12+
const devtoolsServer = new ServerEventBus()
1313

1414
devtoolsServer.start()
1515

@@ -19,9 +19,9 @@ export { devtoolsServer }
1919
### Client Event Bus
2020

2121
```ts
22-
import { TanstackDevtoolsClientEventBus } from '@tanstack/devtools-event-bus/client'
22+
import { ClientEventBus } from '@tanstack/devtools-event-bus/client'
2323
// Start the client event bus
24-
const devtoolsClient = new TanstackDevtoolsClientEventBus()
24+
const devtoolsClient = new ClientEventBus()
2525

2626
devtoolsClient.start()
2727

@@ -30,4 +30,4 @@ export { devtoolsClient }
3030

3131
## Plugins
3232

33-
Check out @tanstack/devtools-event-bus-plugin for more information on how to create plugins for the event bus.
33+
Check out @tanstack/devtools-event-client for more information on how to create plugins for the event bus.

0 commit comments

Comments
 (0)