id-scanner-lib/README.md

Browser-based ID card, QR code, and face recognition scanner with liveness detection

# ID-Scanner-Lib

一个强大的浏览器端身份证识别、二维码扫描和人脸识别库，具有活体检测功能。

## 功能特点

- **身份证识别**: 支持中国居民身份证识别，提取身份信息和照片
- **二维码扫描**: 支持多种二维码和条形码格式，实时视频扫描
- **人脸识别**: 人脸检测、特征点定位、属性分析和活体检测
- **轻量级**: 优化的代码结构，支持按需加载
- **易于集成**: 简洁的API，适用于各种Web应用
- **跨平台**: 支持PC和移动设备，多种浏览器兼容

## 安装

```bash
npm install id-scanner-lib
```

## 快速开始

### 身份证识别

```javascript
import { IDScanner } from 'id-scanner-lib';

// 创建并初始化扫描器
const scanner = new IDScanner();
await scanner.initialize();

// 获取身份证模块
const idCardModule = scanner.getIDCardModule();

// 识别身份证
const imageElement = document.getElementById('id-card-image');
const result = await idCardModule.recognize(imageElement);

console.log('姓名:', result.name);
console.log('身份证号:', result.idNumber);
console.log('地址:', result.address);
```

### 二维码扫描

```javascript
// 获取二维码模块
const qrCodeModule = scanner.getQRCodeModule();

// 从图像中扫描二维码
const qrImage = document.getElementById('qr-image');
const qrResult = await qrCodeModule.scan(qrImage);

console.log('二维码内容:', qrResult.data);
```

### 人脸识别

```javascript
// 获取人脸模块
const faceModule = scanner.getFaceModule();

// 检测人脸
const faceImage = document.getElementById('face-image');
const faceResult = await faceModule.detectFace(faceImage);

console.log('检测到人脸:', faceResult.boundingBox);
console.log('置信度:', faceResult.confidence);

// 人脸比对
const face1 = document.getElementById('face1');
const face2 = document.getElementById('face2');
const comparison = await faceModule.compareFaces(face1, face2);

console.log('相似度:', comparison.similarity);
console.log('是否匹配:', comparison.isMatch);
```

## 文档

完整文档请访问我们的[官方文档网站](https://agions.github.io/id-scanner-lib/)

## 演示

- [身份证识别演示](https://agions.github.io/id-scanner-lib/demos/idcard.html)
- [二维码扫描演示](https://agions.github.io/id-scanner-lib/demos/qrcode.html)
- [人脸识别演示](https://agions.github.io/id-scanner-lib/demos/face.html)

## 浏览器兼容性

- Chrome 60+
- Firefox 55+
- Safari 11+
- Edge 79+
- Opera 47+
- iOS Safari 11+
- Android Chrome 60+

## 许可证

[MIT](LICENSE)