pipwave-ekyc-uikit 0.0.1-beta.1 → 0.0.1-beta.10

package/.env.development

@@ -0,0 +1 @@
+FACE_MODEL=/face-models

package/.env.production

@@ -0,0 +1 @@
+FACE_MODEL=https://assets.pipwave.com/ekyc/sdk/face-models

package/README.md

@@ -31,24 +31,67 @@ You need to provide one html div element along with id attributes
 
 Add the scripts below to your project, to start render the uikit.
 The script first initialized the uikit, then call the init method and
-passed in the id of the div container, and access token
+passed in an object at the first init function parameter. The object requires
+three key to be passed in as listed below:
 
-Note: The first parameter should be the id of the html element you set
+target: The id of the container that will be used to display the ekyc
+accessToken: The accessToken for the user that need to undergo the ekyc process
+displayMode: To determine the display of the ekyc gui. Supported value is 'in-page' and 'hpp'.
+Default: 'in-page'
 
 ```javascript
+import PWUISDK from 'pipwave-ekyc-uikit';
+
 const pw = new PWUISDK()
-pw.init('pw-sdk-container', <accessToken>)
+pw.init({
+  target: 'pw-sdk-container',
+  accessToken: //<AccessToken>
+  displayMode: //'in-page' | 'hpp'
+})
 ```
 
-### `listenToFinishEkyc {Function} optional`
+### `onFinish {Function} optional`
 
 Call back that fires when the eKYC process is done
 
-Example `listenToFinishEkyc` callBack:
+Example `onFinish` callBack:
+
+```javascript
+pw.onFinish(() => {
+  // do your own handling here
+});
+```
+
+### `onClose {Function} optional`
+
+Call back that fires when the eKYC process is closed
+
+Example `onClose` callBack:
 
 ```javascript
-pw.listenToFinishEkyc(() => {
-  // alert('eKYC process finished')
+pw.onClose(() => {
   // do your own handling here
 });
 ```
+
+### Configuration
+
+#### Installation on Angular Base Project
+
+For Angular-based projects, you'll need to include the `face-api.js` library in your project's `angular.json` configuration:
+
+```
+"architect": {
+  "build": {
+    "options": {
+      "scripts": ["./node_modules/face-api.js/dist/face-api.min.js"]
+    }
+   }
+}
+```
+
+## Acknowledgements
+
+We extend our gratitude to the following open-source projects that greatly contributed to the development of the Pipwave Ekyc Uikit: `pipwave-ekyc-sdk`,`webpack`, `face-api.js`, `moment`, `pikaday`
+
+Thank you to these remarkable projects and their dedicated teams for making our Uikit possible. Your efforts are truly appreciated.