@microblink/blinkid-verify-core 3.20.0-rc.0

package/README.md

@@ -0,0 +1,71 @@
+# @microblink/blinkid-verify-core
+
+This package provides the core BlinkID Verify functionality for browser-based card scanning. It exposes a low-level API for initializing and controlling the BlinkID Verify engine, managing sessions, and processing images. It can be used directly by end users for advanced or custom integrations, or as a dependency of higher-level packages such as [`@microblink/blinkid-verify`](https://www.npmjs.com/package/@microblink/blinkid-verify).
+
+## Overview
+
+- Provides the main API for BlinkID Verify scanning and recognition in the browser.
+- Handles initialization, licensing, and session management.
+- Can be used directly by end users for advanced use cases.
+- Used internally by [`@microblink/blinkid-verify`](https://www.npmjs.com/package/@microblink/blinkid-verify).
+
+## Installation
+
+Install from npm using your preferred package manager:
+
+```sh
+npm install @microblink/blinkid-verify-core
+# or
+yarn add @microblink/blinkid-verify-core
+# or
+pnpm add @microblink/blinkid-verify-core
+```
+
+## Usage
+
+You can use `@microblink/blinkid-verify-core` directly in your project for custom integrations. See the example apps in the `apps/examples` directory in the GitHub repository for usage details.
+
+## Environment & Setup
+
+- ESM-only: Use in browsers with a bundler (e.g., Vite) or via [`<script type="module">`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules#applying_the_module_to_your_html).
+- Can also be used via [esm.sh](https://esm.sh/) for direct HTTP imports.
+
+### License key
+
+A valid license key is required. Request a free trial at [Microblink Developer Hub](https://developer.microblink.com/register).
+
+### Hosting resources
+
+You must host the `dist/resources` directory from this package without modification. It contains:
+
+- WebAssembly `.wasm` and `.data` files
+- Emscripten JS glue code
+- The `@microblink/blinkid-verify-worker` Web Worker script
+
+### Hosting requirements
+
+- Must be served in a [secure context](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts).
+- For multithreaded builds, your site must be [cross-origin isolated](https://web.dev/articles/why-coop-coep):
+
+  ```http
+  Cross-Origin-Embedder-Policy: require-corp
+  Cross-Origin-Opener-Policy: same-origin
+  ```
+
+## Development
+
+To build the package locally:
+
+1. Install dependencies in the monorepo root:
+
+   ```sh
+   pnpm install
+   ```
+
+2. Build the package:
+
+   ```sh
+   pnpm build
+   ```
+
+The output files will be available in the `dist/` and `types/` directories.