Skip to content

Commit 7f033d4

Browse files
authored
Update README.md
1 parent dd1b5ce commit 7f033d4

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
## Introduction
1919

20-
Through the Chat SDK for Javascript, you can efficiently integrate real-time chat into your client app. On the client-side implementation, you can initialize, configure and build the chat with minimal effort. On the server-side, Sendbird ensures reliable infra-management services for your chat within the app. This **read.me** provides the Chat SDK’s structure, supplementary features, and the installation steps.
20+
Through Sendbird Chat SDK for Javascript, you can efficiently integrate real-time chat into your client app. On the client-side implementation, you can initialize, configure and build the chat with minimal effort. On the server-side, Sendbird ensures reliable infra-management services for your chat within the app. This **read.me** provides the Chat SDK’s structure, supplementary features, and the installation steps.
2121

2222
### How it works
2323

@@ -160,7 +160,7 @@ Or download the latest Chat SDK for JavaScript from the following link if you do
160160

161161
- https://github.com/sendbird/Sendbird-SDK-JavaScript
162162

163-
> Note: You should also add axios library into the script tag before the Sendbird library inclusion since v3.0.127. You can host the library or utilize the CDN as the library refers to it. The following serves as examples.
163+
> **Note**: You should also add `axios` library into the <script> tag before the Sendbird library inclusion since v3.0.127. You can host the library or utilize the CDN as the library refers to it. The following serves as examples.
164164
165165
```javascript
166166
<script src="https://unpkg.com/axios/dist/axios.min.js"></script>
@@ -183,7 +183,7 @@ You need to initialize a `sb` instance before authentication. Initialization bin
183183

184184
To initialize a `Sendbird` instance, pass the `App_ID` of your Sendbird application in the dashboard as an argument to a parameter in the `new Sendbird()` method. As the `new SendBird()` can only be a single instance, call it only a single time across your Javascript client app. Typically, initialization is implemented in the user login screen.
185185

186-
> Note: It is recommended to initialize the Chat SDK at the top of your Javascript file.
186+
> **Note**: It is recommended to initialize the Chat SDK at the top of your Javascript file.
187187
188188
```javascript
189189
var sb = new SendBird({appId: APP_ID});
@@ -220,7 +220,7 @@ Sendbird prefers that you pass the APP ID through the use of a token, as it ensu
220220
sb.connect(USER_ID, ACCESS_TOKEN, function(user, error) {});
221221
```
222222

223-
#### Tips for user account security
223+
#### - Tips for user account security
224224

225225
From **Settings** > **Application** > **Security** > **Access token permission** setting in your dashboard, you can prevent users without an access token from logging in to your Sendbird application or restrict their access to **read** and **write** messages.
226226

@@ -280,7 +280,7 @@ Sendbird wants customers to be confident that Chat SDK will be useful, work well
280280

281281
XSS (Cross-site scripting) is a type of computer security vulnerability. XSS helps attackers inject client-side scripts into web pages viewed by other users. Users can send any type of string data without restriction through Chat SDKs. Make sure that you check the safety of received data from other users before rendering it into your DOM.
282282

283-
> Note: For more about the XSS prevention, visit the [OWASP's XSS Prevention Cheat Sheet](https://cheatsheetseries.owasp.org/cheatsheets/Cross_Site_Scripting_Prevention_Cheat_Sheet.html) page.
283+
> **Note**: For more about the XSS prevention, visit the [OWASP's XSS Prevention Cheat Sheet](https://cheatsheetseries.owasp.org/cheatsheets/Cross_Site_Scripting_Prevention_Cheat_Sheet.html) page.
284284
285285
### Use functions of Sendbird objects with Immutable-js
286286

@@ -317,19 +317,17 @@ sb.connect(USER_ID, function(error, user) {});
317317

318318
The `sb.setErrorFirstCallback(false)` returns callbacks to their original parameter ordering, with errors last.
319319

320-
> Note: Go to the [Event handler](https://sendbird.com/docs/chat/v3/javascript/guides/event-handler) page to learn more about the usages of the Chat SDK's handlers and callbacks.
320+
> **Note**: Go to the [Event handler](https://sendbird.com/docs/chat/v3/javascript/guides/event-handler) page to learn more about the usages of the Chat SDK's handlers and callbacks.
321321
322322
<br />
323323

324324
## Changelogs
325325

326326
### v3.0.138(OCT 30, 2020)
327327

328-
If you want to check the record of other version, go to [Change Log](https://github.com/sendbird/Sendbird-SDK-JavaScript/blob/master/CHANGELOG.md).
328+
If you want to check the record of other versions, go to [Change Log](https://github.com/sendbird/Sendbird-SDK-JavaScript/blob/master/CHANGELOG.md).
329329

330330
- Added `getAllowFriendDiscovery()` and `setAllowFriendDiscovery()` in `SendBird`.
331331
- If it's set to **false**, `uploadFriendDiscoveries()` called by others does not add the user as a friend.
332332
- Set `size` in `FileMessage` automatically.
333333
- Improved stability.
334-
335-
### [More changelogs](https://github.com/sendbird/Sendbird-SDK-JavaScript/blob/master/CHANGELOG.md)

0 commit comments

Comments
 (0)