Skip to content

Commit

Permalink
chore(): readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
tiagosiebler committed Jun 13, 2024
1 parent 3a3efee commit 33d16ee
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ client
});
```

See [RestClient.ts](./src/RestClient.ts) for further information, or the [examples](./examples/) for lots of usage examples.
See [RestClient](./src/RestClient.ts) for further information, or the [examples](./examples/) for lots of usage examples.

## WebSockets

Expand Down Expand Up @@ -243,11 +243,11 @@ ws.on('error', (err) => {
});
```

See [WebsocketClient.ts](./src/WebsocketClient.ts) for further information and make sure to check the [examples](./examples/) folder for much more detail.
See [WebsocketClient](./src/WebsocketClient.ts) for further information and make sure to check the [examples](./examples/) folder for much more detail.

### Websocket API

The [WebsocketClient.ts](./src/WebsocketClient.ts) supports this exchange's Websocket API. There are two ways to use the WS API, depending on individual preference:
The [WebsocketClient](./src/WebsocketClient.ts) supports this exchange's Websocket API. There are two ways to use the WS API, depending on individual preference:

- event-driven:
- send requests via `client.sendWSAPIRequest(wsKey, channel, params)`, fire and forget, don't use await
Expand Down

0 comments on commit 33d16ee

Please sign in to comment.