biometry-sdk 1.2.2 → 1.2.3

package/README.md

@@ -1,25 +1,16 @@
 # biometry-sdk
 
 ## Overview
-The **Biometry Web SDK** is a software development kit designed to simplify the integration of Biometry's API services into your web application. Providing tools, UI components, and utilities enables biometric onboarding (face and voice), liveness checks, and user consent.
-
+The **Biometry Web SDK** is a software development kit (SDK) designed to facilitate the integration of Biometry's API services.
 
 ## Features
-- **Consent Management**:
-  - Ask a permission to store their biometric data for authentication using Biometry.
-  - Collect user permission to store their biometric data for authentication using Biometry.
-  - Important: You must obtain consent before performing any onboarding or video processing.
-- **Voice onboarding**:
-  - Enroll a user’s voice, creating a voice model for future authentication.
+- **Consent management**: Ask a permission to store their biometric data for authentication using Biometry.
+- **Voice onboarding**: Onboard voice for Voice Recognition.
 - **Face onboarding**: Onboard face for face recognition.
-  - Onboard a user’s face for facial recognition.
-  - **Face Onboarding UI Component:** A ready-to-use, customizable component for capturing and processing face data.
-- **Face match**:
-  - Compares an extracted image from a user’s personal document to an image frame captured during onboarding or  `/process-video.`
-- **Process video**:
-  - Checks user liveness and authorizes users based on video input.
-  - **Process Video UI Component:** A ready-to-use, customizable component for capturing and processing video.
-
+  - Includes a customizable **Face Onboarding UI Component** for streamlined user interactions.
+- **Face match**: Compares extracted image from user’s personal document with the frame from the `/process-video.`
+- **Process video**: Process the video through Biometry services to check liveness and authorize user.
+  - (UI Component for this feature coming soon)
 
 ## Installation
 ```bash
@@ -42,30 +33,31 @@ console.log(response);
 
 ## Example
 
-You can find an example in the example/ directory. The example demonstrates how you might integrate the BiometrySDK in a React component with the state. 
+You can find an example in the example/ directory. The example demonstrates how to integrate the SDK into a React app.
+
 ## UI Components
-The Biometry Web SDK includes reusable, customizable web components for crucial features. These components are easy to embed into your application and handle the most common biometric operations with minimal setup.
+The **Biometry Web SDK** includes reusable and customizable web components for key features. These components make it simple to add biometric functionalities to your application.
 
 ### Face Onboarding Component
-This component provides an intuitive interface for onboarding users with their cameras. It integrates directly with the `BiometrySDK backend`, managing camera capture, consent checks, and error handling.
+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.
 
 ### Integration
 Here's how to integrate the `Face Onboarding` component into your application:
 
 **Option 1: Using npm (Recommended for full SDK usage)**
 1. Install the SDK package via **npm**:
-    ```bash
-    npm install biometry-sdk
-    ```
+```bash
+npm install biometry-sdk
+```
 2. Import the component in your **index.js** or equivalent JavaScript file:
-    ```javascript
-    // index.js
-    import './node_modules/biometry-sdk/dist/components/biometry-onboarding.js';
-    ```
+```javascript
+// index.js
+import './node_modules/biometry-sdk/dist/components/biometry-onboarding.js';
+```
 3. Connect the script to your **HTML file** and use the component:
-    ```html
-    <script type="module" src="./index.js"></script>
-    ```
+```html
+<script type="module" src="./index.js"></script>
+```
 
 
 **Option 2: Using CDN (Quick Integration)**
@@ -74,14 +66,9 @@ Here's how to integrate the `Face Onboarding` component into your application:
 ```
 
 ### Usage
-**Required attributes:**
-- `api-key`: Your Biometry API key.
-- `user-fullname`: The user’s full name (used in data storage and consent).
+The `api-key` and `user-fullname` attributes are required for the component to function.
 
-**Slots:**
-- `video`: Your custom <video> element.
-- `button`: Custom capture button.
-- `loading`, `success`, `error-no-face`, `error-multiple-faces`, `error-not-centered`, `error-other`: Custom UI messages for different states.
+Custom slots allow you to style and customize UI elements, loading, success, and error states.
 
 **Basic Usage**
 ```html
@@ -111,31 +98,38 @@ Here's how to integrate the `Face Onboarding` component into your application:
 ```
 
 ### Process Video Component
-The **Process Video** component enables you to record, upload, and process a video within your application. It integrates with Biometry's services to check liveness and authorize the user.
+The Process Video component allows developers to record, upload, and process video directly within their applications through Biometry services to check liveness and authorize user.
 
 ### Integration
 **Option 1: Install via npm**
+
 1. To include the component in your project, install the biometry-sdk package:
-   ```bash
-    npm install biometry-sdk
-    ```
+```bash
+npm install biometry-sdk
+```
+
 2. After installation, import the component into your project:
-   ```javascript
-    // index.js
-    import './node_modules/biometry-sdk/dist/components/process-video.js'
-    ```
+```javascript
+// index.js
+import './node_modules/biometry-sdk/dist/components/process-video.js';
+```
+
 3. Include the component in your HTML:
-   You can skip the npm installation and include the component directly in your HTML:
-   ```html
-    <script type="module" src="./index.js"></script>
-    <process-video ...></process-video>
-   ```
-**Option 2: Using CDN (Quick Integration)**
+```html
+<script type="module" src="./index.js"></script>
+<process-video ...></process-video>
+```
+
+**Option 2: Import directly via CDN**
+
+You can skip the npm installation and include the component directly in your HTML:
 ```html
 <script type="module" src="https://cdn.jsdelivr.net/npm/biometry-sdk/dist/components/process-video.js"></script>
 <process-video ...></process-video>
 ```
+
 ### Usage
+
 **Basic Usage**
 ```html
 <process-video
@@ -169,35 +163,16 @@ The **Process Video** component enables you to record, upload, and process a vid
   <div slot="success">Video submitted successfully!</div>
 </process-video>
 ```
-**Note:**
-- All default elements and messages are functional out-of-the-box.
-- Replace slots if you want to customize the UI or functionality.
-- Call giveConsent() before using any biometric methods to ensure compliance with data processing requirements.
-
-## Best Practices
-1. **Always Acquire Consent**
-   - Before performing Face Onboarding or Process Video, you can call:
-     ```javascript
-      sdk.giveConsent(true, userFullName);
-     ```
-   - Or directly send a request to the `/consent` in the [official documentation](https://developer.biometrysolutions.com/overview/).
-   
-   This ensures legal compliance and user awareness when storing and processing biometric data.
-3. **Handle Errors Gracefully**
-   - The SDK methods throw errors if something goes wrong (e.g., network, permission, or detection errors). Use try/catch or .catch() to handle them.
-4. **Security**
-   - Protect your API key. Avoid exposing it in public repositories or client-side code if possible.
-   
+
+**Notes**
+- By default, all elements are functional without customization. Replace slots only if customization is required.
+
+- To regenerate the video preview or handle custom actions, use JavaScript to interact with the provided slots or the component's public methods.
+
 ## License
 
 This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
 
 ## More Information
-For more detailed information on Biometry’s API endpoints, parameters, and responses, visit the official [Biometry API Documentation](https://developer.biometrysolutions.com/overview/). If you have questions or need help, please reach out to our support team or create a GitHub issue.
-
-## Quick Reference
-- Install: `npm install biometry-sdk`
-- Consent: `sdk.giveConsent(true, userFullName)` (Required before onboarding/processing)
-- Voice Onboarding: `sdk.enrollVoice(file, userFullName)`
-- Face Onboarding: `sdk.enrollFace(file, userFullName)`
-- Process Video: `sdk.processVideo(file, phrase, userFullName)`
+
+For more detailed documentation on the Biometry API, visit the [official documentation](https://developer.biometrysolutions.com/overview/).