Skip to content

Commit cb0d998

Browse files
authored
Update README.md
1 parent 8833656 commit cb0d998

File tree

1 file changed

+20
-31
lines changed

1 file changed

+20
-31
lines changed

README.md

Lines changed: 20 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,6 @@
44

55
React native wrapper for zendesk unified SDK. Supports both iOS and Android platforms.
66

7-
# NOTICE
8-
This is my very first npm package and I am still a newbie. Anyone if has suggestions/improvements or any feature PRs you are most welcome, would love to get make the package as much generalised for everyone as possible. Only very basic stuff is supported at this moment.
9-
10-
117
## VERSIONS
128
It's an alpha version release as of now and only tested on RN >=0.61.0. Bugs and issues can be there.
139

@@ -51,10 +47,10 @@ Place this code at the root of your application to initialize Zendesk SDK.
5147
For all supported SDKs
5248
```javascript
5349
RNZendeskChat.init({
54-
key: <chatAccountKey>,
55-
appId: <appId>,
56-
url: <zendeskUrl>,
57-
clientId: <zendeskClientId>,
50+
key: <chatAccountKey>,
51+
appId: <appId>,
52+
url: <zendeskUrl>,
53+
clientId: <zendeskClientId>,
5854
})
5955
```
6056

@@ -65,29 +61,29 @@ Step 2. Set user identifier
6561
- If your chat just runs behind a login you can pass in name and email whenever user logins if not, pass a JWT Token to identify the user on chat
6662

6763
```
68-
RNZendeskChat.setUserIdentity({
69-
name: <name>,
70-
email: <email>,
71-
})
64+
RNZendeskChat.setUserIdentity({
65+
name: <name>,
66+
email: <email>,
67+
})
7268
```
7369
- If you want to start chat without any user details you can use a JWT token.
7470
```
75-
RNZendeskChat.setUserIdentity({
71+
RNZendeskChat.setUserIdentity({
7672
token: <JWT TOKEN>
77-
})
73+
})
7874
```
7975

8076
Step 3. Show the UI based on what SDK you want to use
8177
### Chat SDK
8278
** To use chat sdk without answer bot, please add `chatOnly: true` in this method
8379
```
84-
ZendeskChat.startChat({
85-
name: user.full_name,
86-
email: user.email,
87-
phone: user.mobile_phone,
88-
tags: ['tag1', 'tag2'],
89-
department: "Your department"
90-
});
80+
ZendeskChat.startChat({
81+
name: user.full_name,
82+
email: user.email,
83+
phone: user.mobile_phone,
84+
tags: ['tag1', 'tag2'],
85+
department: "Your department"
86+
});
9187
```
9288
| Props | Description |
9389
|--|--|
@@ -104,8 +100,8 @@ Step 3. Show the UI based on what SDK you want to use
104100
To initiate and display help center use the following method:
105101
```
106102
RNZendesk.showHelpCenter({
107-
withChat: true // add this if you want to use chat instead of ticket creation
108-
disableTicketCreation: true // add this if you want to just show help center and not add ticket creation
103+
withChat: true // add this if you want to use chat instead of ticket creation
104+
disableTicketCreation: true // add this if you want to just show help center and not add ticket creation
109105
})
110106
```
111107
You can use either of these options `withChat` or `disableTicketCreation`, both can't be used together.
@@ -149,13 +145,6 @@ For iOS only added a new function which can be used as below. This would set the
149145
150146
```
151147

152-
### Push notifications
153-
For push notifications added a method to register token in Zendesk, all other handling and stuff needs to be done on the app itself.
154-
To register your token with Zendesk call
155-
```
156-
RNZendesk.setNotificationToken(<your token>)
157-
```
158-
159148
## TODO
160149

161150
- ~~Add Help center~~
@@ -166,7 +155,7 @@ RNZendesk.setNotificationToken(<your token>)
166155
- Exposing individual methods to support all SDKs and different combinations
167156
- Add more support of dynamic properties
168157
- More config for looks on iOS
169-
- Add support for PushNotifications
158+
- ~~Add support for PushNotifications~~
170159

171160
Contributions and PRs are always welcome.
172161

0 commit comments

Comments
 (0)