Skip to content

Commit 529bb79

Browse files
committed
Update the SDK installation command and terminology in README.md
MOB-4142
1 parent a2cbde4 commit 529bb79

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

README.md

+8-10
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ GliaWidgets SDK is a simple and customisable framework built on top of GliaSDK.
77
To install the @salemove/widgets_sdk_ionic package use:
88

99
```text
10-
npm install @salemove/widgets_sdk_ionic
10+
npm install @salemove/widgets_sdk_ionic --legacy-peer-deps
1111
```
1212

1313
# How to use GliaSDK in Ionic environment
1414

1515
```js
16-
// Import `glia-widgets-ionic` plugin
16+
// Import `glia-widgets-ionic` SDK
1717
import { GliaSdk } from 'glia-widgets-ionic';
1818

1919
// Configure SDK
@@ -24,8 +24,8 @@ GliaSdk.configure({
2424
companyName: 'Ionic Company',
2525
});
2626

27-
// Start engagement
28-
GliaSdk.startAudio();
27+
// Show Entry Widget
28+
GliaSdk.presentEntryWidget();
2929
```
3030

3131
## API
@@ -61,9 +61,9 @@ GliaSdk.startAudio();
6161
configure(options: { siteId: string; queueIds?: string[]; apiKey: ApiKey; region: Region; companyName: string; overrideLocale?: string; }) => Promise<void>
6262
```
6363

64-
configures GliaWidgets SDK with credentials.
64+
Configures GliaWidgets SDK with credentials.
6565

66-
NB! To make plugin work properly, use `create-visitor` credentials for Site APIKey only.
66+
NB! Ensure the site API key used in Mobile SDK has the Create Visitor permission only.
6767

6868
| Param | Type |
6969
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -122,7 +122,7 @@ Starts a new video engagement for queue identifiers. If `queueIds` is null or em
122122
startSecureConversation() => Promise<void>
123123
```
124124

125-
Starts Secure Conversation flow with passed `start screen`.
125+
Starts Secure Conversation flow.
126126
Secure Conversation requires authentication/IdToken.
127127

128128
--------------------
@@ -147,8 +147,6 @@ listQueues() => Promise<any>
147147

148148
Fetches all queues with its info for current site.
149149

150-
**Returns:** <code>Promise&lt;any&gt;</code>
151-
152150
--------------------
153151

154152

@@ -195,7 +193,7 @@ Deauthenticates visitor. Be aware that deauthentication process relies on <a hre
195193
isAuthenticated() => Promise<void>
196194
```
197195

198-
Provides current authentication state
196+
Provides current authentication state.
199197

200198
--------------------
201199

0 commit comments

Comments
 (0)