diff --git a/README.md b/README.md
index 9724954..3dcb51c 100644
--- a/README.md
+++ b/README.md
@@ -4,16 +4,10 @@ GliaWidgets SDK is a simple and customisable framework built on top of GliaSDK.
## Installation
-To install this package, add the following to your `.npmrc` file:
+To install this package use:
```text
-@salemove:registry=https://npm.pkg.github.com
-```
-
-then run
-
-```shell
-npm install @your-username/ionic-plugin-example
+npm install git+https://github.com/salemove/widgets_sdk_ionic.git
```
# How to use GliaSDK in Ionic environment
@@ -38,22 +32,22 @@ GliaSdk.startAudio();
-* [`configure(...)`](#configure)
-* [`startChat(...)`](#startchat)
-* [`startAudio(...)`](#startaudio)
-* [`startVideo(...)`](#startvideo)
-* [`startSecureConversation(...)`](#startsecureconversation)
-* [`clearVisitorSession()`](#clearvisitorsession)
-* [`listQueues()`](#listqueues)
-* [`showVisitorCodeViewController()`](#showvisitorcodeviewcontroller)
-* [`authenticate(...)`](#authenticate)
-* [`deauthenticate()`](#deauthenticate)
-* [`isAuthenticated()`](#isauthenticated)
-* [`refreshAuthentication(...)`](#refreshauthentication)
-* [`pauseLiveObservation()`](#pauseliveobservation)
-* [`resumeLiveObservation()`](#resumeliveobservation)
-* [Interfaces](#interfaces)
-* [Type Aliases](#type-aliases)
+- [`configure(...)`](#configure)
+- [`startChat(...)`](#startchat)
+- [`startAudio(...)`](#startaudio)
+- [`startVideo(...)`](#startvideo)
+- [`startSecureConversation(...)`](#startsecureconversation)
+- [`clearVisitorSession()`](#clearvisitorsession)
+- [`listQueues()`](#listqueues)
+- [`showVisitorCodeViewController()`](#showvisitorcodeviewcontroller)
+- [`authenticate(...)`](#authenticate)
+- [`deauthenticate()`](#deauthenticate)
+- [`isAuthenticated()`](#isauthenticated)
+- [`refreshAuthentication(...)`](#refreshauthentication)
+- [`pauseLiveObservation()`](#pauseliveobservation)
+- [`resumeLiveObservation()`](#resumeliveobservation)
+- [Interfaces](#interfaces)
+- [Type Aliases](#type-aliases)
@@ -74,8 +68,7 @@ NB! To make plugin work properly, use `create-visitor` credentials for Site APIK
| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`options`** | { siteId: string; apiKey: ApiKey; region: Region; companyName: string; overrideLocale?: string; }
|
---------------------
-
+---
### startChat(...)
@@ -89,8 +82,7 @@ Starts a new chat/text engagement with queue identifiers. If `queueIds` is null
| ------------- | ------------------------------------- |
| **`options`** | { queueIds?: string[]; }
|
---------------------
-
+---
### startAudio(...)
@@ -104,8 +96,7 @@ Starts a new audio engagement with queue identifiers. If `queueIds` is null or e
| ------------- | ------------------------------------- |
| **`options`** | { queueIds?: string[]; }
|
---------------------
-
+---
### startVideo(...)
@@ -119,8 +110,7 @@ Starts a new video engagement for queue identifiers. If `queueIds` is null or em
| ------------- | ------------------------------------- |
| **`options`** | { queueIds?: string[]; }
|
---------------------
-
+---
### startSecureConversation(...)
@@ -135,8 +125,7 @@ Secure Conversation requires authentication/IdToken.
| ------------- | --------------------------------------------------------------------------------------------------------- |
| **`options`** | { startScreen: SecureConversationStartScreen; }
|
---------------------
-
+---
### clearVisitorSession()
@@ -146,8 +135,7 @@ clearVisitorSession() => Promise
Recreates currently used visitor in SDK.
---------------------
-
+---
### listQueues()
@@ -159,8 +147,7 @@ Fetches all queues with its info for current site.
**Returns:** Promise<any>
---------------------
-
+---
### showVisitorCodeViewController()
@@ -170,8 +157,7 @@ showVisitorCodeViewController() => Promise
Presents GliaWidgets UI with visitor code for sharing with operator to start an engagement.
---------------------
-
+---
### authenticate(...)
@@ -185,8 +171,7 @@ Authenticates visitor.
| ------------- | ------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| **`options`** | { behavior: AuthenticationBehavior; idToken: string; accessToken?: string; }
| - Provides options for authentication such as behavior, idToken, and accessToken. |
---------------------
-
+---
### deauthenticate()
@@ -196,8 +181,7 @@ deauthenticate() => Promise
Deauthenticates visitor. Be aware that deauthentication process relies on `AuthenticationBehavior`
---------------------
-
+---
### isAuthenticated()
@@ -207,8 +191,7 @@ isAuthenticated() => Promise
Provides current authentication state
---------------------
-
+---
### refreshAuthentication(...)
@@ -222,8 +205,7 @@ Refreshes authentication access properties.
| ------------- | ------------------------------------------------------- |
| **`options`** | { idToken: string; accessToken?: string; }
|
---------------------
-
+---
### pauseLiveObservation()
@@ -233,8 +215,7 @@ pauseLiveObservation() => Promise
Makes a pause for ongoing LiveObservation session.
---------------------
-
+---
### resumeLiveObservation()
@@ -244,12 +225,10 @@ resumeLiveObservation() => Promise
Resumes ongoing LiveObservation session.
---------------------
-
+---
### Interfaces
-
#### ApiKey
| Prop | Type |
@@ -257,24 +236,20 @@ Resumes ongoing LiveObservation session.
| **`id`** | string
|
| **`secret`** | string
|
-
### Type Aliases
-
#### Region
Site's region.
'us' | 'eu' | 'beta'
-
#### SecureConversationStartScreen
Start screen for Secure Conversation flow.
'welcome' | 'chatTranscript'
-
#### AuthenticationBehavior
Authentication (IdToken) behavior.
diff --git a/example-app/package.json b/example-app/package.json
index 57d66cc..75c325c 100644
--- a/example-app/package.json
+++ b/example-app/package.json
@@ -3,6 +3,18 @@
"version": "1.0.0",
"description": "An Amazing Capacitor App",
"type": "module",
+ "main": "dist/index.js",
+ "module": "dist/index.mjs",
+ "types": "dist/index.d.ts",
+ "exports": {
+ ".": {
+ "import": "./dist/index.mjs",
+ "require": "./dist/index.js"
+ }
+ },
+ "files": [
+ "dist"
+ ],
"keywords": [
"capacitor",
"mobile"
@@ -25,5 +37,5 @@
"vite": "^5.4.2"
},
"author": "",
- "license": "ISC"
-}
\ No newline at end of file
+ "license": "MIT"
+}