Skip to content

Commit fb367cf

Browse files
committed
updated readme file for chat and video chat samples
1 parent 7494101 commit fb367cf

File tree

2 files changed

+93
-45
lines changed

2 files changed

+93
-45
lines changed

samples/chat/README.md

Lines changed: 41 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,53 @@ QuickBlox JS Sample Chat
33

44
This is a code sample for [QuickBlox](http://quickblox.com/) platform. It is a great way for developers using QuickBlox platform to learn how to integrate private and group chat, add text and image attachments sending into your application.
55

6-
# Credentials
6+
# Get application credentials
7+
[](#get-application-credentials)
78

8-
Welcome to QuickBlox [Credentials](https://quickblox.com/developers/5_Minute_Guide), where you can get your credentials in just 5 minutes! All you need is to:
9+
QuickBlox application includes everything that brings messaging right
10+
into your application - chat, video calling, users, push notifications,
11+
etc. To create a QuickBlox application, follow the steps below:
912

10-
1. Register a free QuickBlox account and add your App there.
11-
2. Update credentials in your application code.[Chat](https://quickblox.com/developers/5_Minute_Guide#Update_authentication_credentials_3)
13+
1. Register a new account following [this
14+
link](https://admin.quickblox.com/signup). Type in your email and
15+
password to sign in. You can also sign in with your Google or Github
16+
accounts.
17+
2. Create the app clicking **New app** button.
18+
3. Configure the app. Type in the information about your organization
19+
into corresponding fields and click **Add** button.
20+
4. Go to **Dashboard =\> *YOUR\_APP* =\> Overview** section and copy
21+
your **Application ID**, **Authorization Key**, **Authorization
22+
Secret**, and **Account Key**.
1223

13-
# Chat Sample
24+
# Run chat sample
1425

15-
This Sample demonstrates how to work with [Chat](https://quickblox.com/developers/Web_XMPP_Chat_Sample#Guide:_Getting_Started_with_Chat_API) QuickBlox module.
26+
To run a code sample, follow the steps below:
1627

17-
It allows:
28+
1. Download the code sample.
29+
2. [Get application credentials](#get-application-credentials) and get appId, authKey, authSecret, and accountKey.
30+
3. Put these values in file **QBconfig.js** following **samples =\>
31+
chat =\> js** directory.
1832

19-
1. Authenticate with Quickblox Chat and REST.
20-
2. Receive and display list of dialogs.
21-
3. Modify dialog by adding occupants.
22-
4. Real-time chat messaging and attachment's handling.
33+
JavaScript
34+
35+
var QBconfig = {
36+
credentials: {
37+
appId: '',
38+
authKey: '',
39+
authSecret: '',
40+
accountKey: ''
41+
}
42+
}
43+
44+
4. Run the code sample by opening **index.html** file.
45+
46+
# Requirements
47+
[](#requirements)
48+
49+
The minimum requirements for QuickBlox JavaScript SDK are:
50+
51+
- JavaScript es5.
2352

2453
# Documentation
2554

26-
Original sample description & setup guide - [JS Chat Sample](https://quickblox.com/developers/Web_XMPP_Chat_Sample#Guide:_Getting_Started_with_Chat_API)
55+
Sample documentation is available [here](https://quickblox.com/developers/Web_XMPP_Chat_Sample#Guide:_Getting_Started_with_Chat_API).

samples/webrtc/README.md

Lines changed: 52 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -9,27 +9,56 @@ The WebRTC VideoChat code sample allows you easily to add the video calling feat
99

1010
It is built on the top of the WebRTC technology.
1111

12-
#Prepare your application for Javascript SDK
13-
Preparation includes the following steps:
14-
15-
#Create QuickBlox account
16-
Register an application in Dashboard
17-
Integrate QuickBlox SDK into application
18-
Register a QuickBlox account
19-
https://quickblox.com/signup/
20-
21-
#Create application in the Admin panel
22-
https://admin.quickblox.com/apps/new
23-
24-
# Credentials
25-
26-
Welcome to QuickBlox [5 Minute Guide](https://quickblox.com/developers/5_Minute_Guide), where you can get your credentials in just 5 minutes!
27-
28-
29-
# Sample description & setup guide.
12+
# Get application credentials
13+
[](#get-application-credentials)
14+
15+
QuickBlox application includes everything that brings messaging right
16+
into your application - chat, video calling, users, push notifications,
17+
etc. To create a QuickBlox application, follow the steps below:
18+
19+
1. Register a new account following [this
20+
link](https://admin.quickblox.com/signup). Type in your email and
21+
password to sign in. You can also sign in with your Google or Github
22+
accounts.
23+
2. Create the app clicking **New app** button.
24+
3. Configure the app. Type in the information about your organization
25+
into corresponding fields and click **Add** button.
26+
4. Go to **Dashboard =\> *YOUR\_APP* =\> Overview** section and copy
27+
your **Application ID**, **Authorization Key**, **Authorization
28+
Secret**, and **Account Key**.
29+
30+
31+
# Run video calling sample
32+
[](#video-chat-sample)
33+
34+
To run a code sample, follow the steps below:
35+
36+
1. Download the code sample.
37+
2. [Get application credentials](#get-application-credentials) and get appId, authKey, authSecret and accountKey.
38+
39+
3. Put these values in **config.js** file located at the root catalog
40+
folder.
41+
42+
JavaScript
43+
44+
const creds = {
45+
appId: '',
46+
authKey: '',
47+
authSecret: '',
48+
accountKey: ''
49+
};
50+
51+
4. Run the code sample by opening **index.html** file.
52+
53+
To ensure that the code sample runs smoothly, run it using the https
54+
protocol or localhost. Our sample includes WebRTC
55+
`getUserMedia()` method requesting for webrtc permissions and this method
56+
does not work with HTTP protocol. For that reason, to run a webrtc
57+
sample, https protocol or the localhost must be used.
58+
59+
# Sample description
3060

3161
This Sample demonstrates how to work with [JavaScript VideoChat](https://quickblox.com/developers/Sample-webrtc-web) QuickBlox module.
32-
*this is original sample description & setup guide.
3362

3463
The sample allows to:
3564

@@ -42,18 +71,8 @@ The sample allows to:
4271
7. Screen sharing
4372
8. Switch video input device (camera)
4473

45-
# Browsers support of WebRTC
46-
47-
Desktop:
48-
49-
Chrome (latest)
50-
Firefox (latest)
51-
Opera (latest)
52-
Mobile:
53-
54-
Android Browser (latest)
55-
Opera Mobile (latest)
56-
Chrome for Android (latest)
57-
Firefox for Android (latest)
58-
74+
# Browsers support
5975

76+
| Edge | Firefox | Chrome | Safari | Opera | Node.js |
77+
|:----:|:-------:|:------:|:------:|:-----:|:-------:|
78+
| 14+ | 52+ | 50+ | 11.1+ | 36+ | 6+ |

0 commit comments

Comments
 (0)