Skip to content

Commit a98c3a7

Browse files
authored
Update README
1 parent bcaac00 commit a98c3a7

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,27 @@
11
# sendbird-nodejs
22
Thin wrapper around SendBird Server REST API
33

4+
# PLEASE NOTE THIS WORKS ON TOP OF `SENDBIRD V2.0` API - V3.0 WILL COME SOON
45

56
## Installation
67
`npm install sendbird-nodejs --save`
78

89

910
## Usage
10-
See [SendBird Documentation](https://docs.sendbird.com/platform) for payload and response details.
11+
See [SendBird Documentation](https://docs.sendbird.com/v2/platform) for payload and response details.
1112
You don't need to pass the `auth` field on the payload, you provide it when creating a new instance of `SendBird` and it is attached to all requests.
1213

1314
```javascript
1415
var SendBird = require('sendbird-nodejs');
1516
var sb = new SendBird(config.sendBird.appToken);
1617
```
1718

18-
The `sb` instance we just created has a field for each endpoint in the [SendBird Server API](https://docs.sendbird.com/platform#overview) that is an object with the endpoints methods.
19-
[sb.user](https://docs.sendbird.com/platform#user)
20-
[sb.channel](https://docs.sendbird.com/platform#open_chat)
21-
[sb.messaging](https://docs.sendbird.com/platform#messaging)
22-
[sb.admin](https://docs.sendbird.com/platform#admin)
23-
[sb.migration](https://docs.sendbird.com/platform#migration)
19+
The `sb` instance we just created has a field for each endpoint in the [SendBird Server API](https://docs.sendbird.com/v2/platform#overview) that is an object with the endpoints methods.
20+
[sb.user](https://docs.sendbird.com/v2/platform#user)
21+
[sb.channel](https://docs.sendbird.com/v2/platform#open_chat)
22+
[sb.messaging](https://docs.sendbird.com/v2/platform#messaging)
23+
[sb.admin](https://docs.sendbird.com/v2/platform#admin)
24+
[sb.migration](https://docs.sendbird.com/v2/platform#migration)
2425

2526
So, to create a user you would simply need to have something like this:
2627
```javascript

0 commit comments

Comments
 (0)