Skip to content

Commit b186d03

Browse files
Update README.md file
1 parent b8abe3d commit b186d03

File tree

3 files changed

+27
-7
lines changed

3 files changed

+27
-7
lines changed

LICENSE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
For license information, please visit: https://channelize.io/terms-and-conditions

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Channelize JavaScript SDK
22

3-
This is the official JS-SDK of Channelize.io. Channelize.io allows you to embed user-to-user chat into your application by API and SDKs in the easiest way.
3+
Channelize.io allows you to embed user-to-user chat into your application by API and SDKs in the easiest way.
4+
5+
Signup for Channelize.io 30 Days Free Trial at https://channelize.io/free_trial/request
46

57
## Installation
68

@@ -10,4 +12,14 @@ npm install channelize-chat
1012

1113
## Documentation
1214

13-
You can find out JavaScript SDK documentation [here](https://docs.channelize.io/javascript-sdk-introduction-overview/).
15+
You can find out JavaScript SDK documentation [here](https://docs.channelize.io/javascript-sdk-introduction-overview/).
16+
17+
## How to use
18+
19+
First you need to install channelize-chat via NPM. Then you can import like this:
20+
21+
```javascript
22+
import { Channelize } from 'channelize-chat';
23+
var channelize = new Channelize.client({publicKey: YOUR_PUBLIC_KEY});
24+
// do something...
25+
```

package.json

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,32 @@
11
{
22
"name": "channelize-chat",
33
"version": "4.2.0",
4-
"description": "Channelize JS Sdk - Javascript library for adding messaging platform to your web app.",
4+
"description": "JavaScript SDK for Channelize.io Chat API.",
55
"author": "Channelize.io",
66
"homepage": "https://channelize.io",
77
"repository": "https://github.com/ChannelizeIO/Channelize-Javascript-SDK.git",
88
"main": "./dist/index.js",
99
"browser": {
1010
"./dist/index.js": "./dist/browser.js"
1111
},
12+
"react-native": {
13+
"./dist/index.js": "./dist/browser.js"
14+
},
1215
"scripts": {
1316
"test": "echo \"Error: no test specified\" && exit 1"
1417
},
1518
"keywords": [
16-
"channelize",
17-
"channelize.io",
1819
"chat",
1920
"messaging",
20-
"conversation"
21+
"conversation",
22+
"chat-application",
23+
"realtime-messaging",
24+
"chat-SDK",
25+
"chatapp",
26+
"messenger",
27+
"channelize.io"
2128
],
22-
"license": "ISC",
29+
"license": "SEE LICENSE IN LICENSE.md",
2330
"dependencies": {
2431
"aws-iot-device-sdk": "^2.2.1",
2532
"aws-sdk": "^2.656.0",

0 commit comments

Comments
 (0)