Skip to content

Commit 1513646

Browse files
author
oleksandr-shvetsov-qb
authored
Updated README
1 parent f829578 commit 1513646

File tree

1 file changed

+8
-18
lines changed

1 file changed

+8
-18
lines changed

README.md

Lines changed: 8 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,22 @@
44
See docs at https://docs.quickblox.com/docs/react-native-quick-start
55

66
## Quick Start
7-
This guide demonstarates how to connect quickblox-react-native-sdk to your project and start development.
7+
This guide demonstarates how to connect **quickblox-react-native-sdk** to your project and start development.
88

99
### Create a new app in the Admin Panel
10-
Quickblox application includes everything that brings messaging right into your application - chat, video calling, users, push notifications, etc. To create a QuickBlox application, follow the steps below:
10+
QuickBlox application includes everything that brings messaging right into your application - chat, video calling, users, push notifications, etc. To create a QuickBlox application, follow the steps below:
1111

12-
1. Register a new account. Type in your email and password to sign in. You can also sign in with your Google or Github accounts.
12+
1. Register a new account following [this link](https://admin.quickblox.com/signup). Type in your email and password to sign in. You can also sign in with your Google or Github accounts.
1313
2. Create the app clicking **New app** button.
1414
3. Configure the app. Type in the information about your organization into corresponding fields and click **Add** button.
15-
4. Go to the screen with credentials. Locate **Credentials** groupbox and copy your **Application ID**, **Authorization Key**, and **Authorization Secret**. These data are needed to run your application on QuickBlox server.
15+
4. Go to **Dashboard** --> **Overview** --> **Credentials** groupbox and copy your **Application ID**, **Authorization Key**, **Authorization Secret**, and **Account Key**.
1616

1717
### Install React Native SDK into your app
18-
To connect QuickBlox to your app just add it into your `package.json` in the root directory of the project and enter the following code snippet:
18+
To connect QuickBlox to your app just add it into your dependencies in `package.json` - to do so, in the root directory of the project execute the following command in terminal:
1919

2020
`npm install quickblox-react-native-sdk --save`
2121

22-
iOS and Android have different dependencies systems. For that reason, you need to install dependencies in your iOS project. Just locate **ios/** folder in the root directory of the project and enter the following code snippet.
22+
iOS and Android have different dependencies systems. For that reason, you need to install dependencies in your iOS project. Just locate **ios/** folder in the root directory of the project and enter the following command in terminal:
2323

2424
`pod install`
2525

@@ -102,24 +102,14 @@ QB.chat
102102
occupantsIds: [12345]
103103
})
104104
.then(function (dialog) {
105-
// handle as necessary, i.e.
106-
// subscribe to chat events, typing events, etc.
105+
// handle as necessary
107106
})
108107
.catch(function (e) {
109108
// handle error
110109
});
111110
```
112111

113-
#### Subscribe to receive messages
114-
115-
QuickBlox provides message event handler allowing to notify client apps of events that happen on the chat. Thus, when a dialog has been created, a user can subscribe to receive notifications about new incoming messages. To subscribe to message events call `QB.chat.subscribeMessageEvents` method and pass `dialogId` parameter to it using the following code snippet. The `QB.chat.subscribeMessageEvents` method tells SDK to send events about new messages.
116-
117-
```javascript
118-
QB.chat
119-
.subscribeMessageEvents({ dialogId: 'dsfsd934329hjhkda98793j2' })
120-
.then(function () { })
121-
.catch(function (e) { /* handle error */ });
122-
```
112+
#### Receive messages
123113

124114
To receive new messages, assign event handler using the code snippet below:
125115

0 commit comments

Comments
 (0)