biometry-sdk 1.1.0 → 1.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -4
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# biometry-
|
|
1
|
+
# biometry-sdk
|
|
2
2
|
|
|
3
3
|
## Overview
|
|
4
4
|
The **Biometry Web SDK** is a software development kit (SDK) designed to facilitate the integration of Biometry's API services.
|
|
@@ -41,14 +41,35 @@ The **Biometry Web SDK** includes reusable and customizable web components for k
|
|
|
41
41
|
### Face Onboarding Component
|
|
42
42
|
The `Face Onboarding` component provides an intuitive interface for onboarding users with their camera. It integrates with the `BiometrySDK` to handle backend communication and error states.
|
|
43
43
|
|
|
44
|
-
|
|
44
|
+
### Integration
|
|
45
45
|
Here's how to integrate the `Face Onboarding` component into your application:
|
|
46
46
|
|
|
47
|
-
**
|
|
47
|
+
**Option 1: Using npm (Recommended for full SDK usage)**
|
|
48
|
+
1. Install the SDK package via **npm**:
|
|
49
|
+
```bash
|
|
50
|
+
npm install biometry-sdk
|
|
51
|
+
```
|
|
52
|
+
2. Import the component in your **index.js** or equivalent JavaScript file:
|
|
53
|
+
```javascript
|
|
54
|
+
// index.js
|
|
55
|
+
import './node_modules/biometry-sdk/dist/components/biometry-onboarding.js';
|
|
56
|
+
```
|
|
57
|
+
3. Connect the script to your **HTML file** and use the component:
|
|
58
|
+
```html
|
|
59
|
+
<script type="module" src="./index.js"></script>
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
**Option 2: Using CDN (Quick Integration)**
|
|
48
64
|
```html
|
|
49
|
-
<script type="module" src="
|
|
65
|
+
<script type="module" src="https://cdn.jsdelivr.net/npm/biometry-sdk/dist/components/biometry-onboarding.js"></script>
|
|
50
66
|
```
|
|
51
67
|
|
|
68
|
+
### Usage
|
|
69
|
+
The `api-key` and `user-fullname` attributes are required for the component to function.
|
|
70
|
+
|
|
71
|
+
Custom slots allow you to style and customize UI elements, loading, success, and error states.
|
|
72
|
+
|
|
52
73
|
**Basic Usage**
|
|
53
74
|
```html
|
|
54
75
|
<biometry-onboarding
|
|
@@ -77,6 +98,7 @@ Here's how to integrate the `Face Onboarding` component into your application:
|
|
|
77
98
|
```
|
|
78
99
|
|
|
79
100
|
### Process Video Component
|
|
101
|
+
Coming soon...
|
|
80
102
|
|
|
81
103
|
## License
|
|
82
104
|
|