Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
devteam-frslabs authored Feb 5, 2021
1 parent 671c320 commit 66a48a1
Showing 1 changed file with 66 additions and 1 deletion.
67 changes: 66 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,66 @@
# vimos-web
# VIMOS WEB SDK

![version](https://img.shields.io/badge/version-v1.0.0-blue)

# Table Of Content
- [Quick Start](#quick-start)
- [Help](#help)

## Quick Start

Web SDK Integration

- Import [atlaskyc.js]() script to your HTML file

```html
<script src="atlaskyc.js">
```
- Invoke AtlasKYC on a button click or on similar user input event
```html
<input type="button" onClick="openAtlasKYC()" value="AtlasKYC">
```
Method 1: To open AtlasKYC in a new window
```javascript
function openAtlasKYC(){
let atlasKYC = new AtlasKYC({
method: "window",
onFinish: () => {
// Callback function
}
});
atlasKYC.open(ATLAS_KYC_URL);
}
```
The onFinish function will be called once the KYC is done.
Method 2: To open AtlasKYC in an iframe
Create a DIV element like below
```html
<div class="atlas-kyc"></div>
```
```javascript
function openAtlasKYC(){
let atlasKYC = new AtlasKYC({
method: "iframe",
containerClassName:"atlas-kyc",
onFinish: () => {
// Callback function
}
});
atlasKYC.open(ATLAS_KYC_URL);
}
```
## Help
For any queries/feedback , contact us at `support@frslabs.com`

0 comments on commit 66a48a1

Please sign in to comment.