@face-auth/face-auth
v0.0.1
Published
A meta-package that installs and exposes the full Face-Auth ecosystem: API client, webcam utilities, and real-time video guidelines. The easiest way to add facial authentication to any web project.
Downloads
12,659
Maintainers
Readme
@face-auth/face-auth
Introduction
@face-auth/face-auth is the official meta‑package that bundles and manages all Face‑Auth client‑side libraries in a single dependency.
It ensures version consistency, simplifies installation, and provides a unified interface for projects that require facial authentication workflows.
Included Packages
- @face-auth/face-id: API client for face registration, identification, and removal.
- @face-auth/face-id-video: Browser camera manager and image-capture utilities.
- @face-auth/face-id-video-guidelines: Real‑time visual alignment guides for camera capture.
- Additional Face‑Auth packages may be automatically included as the ecosystem grows.
Features
- Single dependency that installs the complete Face‑Auth toolkit.
- Guaranteed compatibility across all included packages.
- Unified versioning and maintenance.
- Suitable for authentication flows, identity verification, onboarding, kiosks, and any browser‑based face‑capture scenario.
- Framework‑agnostic and lightweight.
Installation
npm install @face-auth/face-auth yarn add @face-auth/face-authNotes
- This meta‑package does not replace any underlying module; it consolidates them for convenience.
- All sub‑packages remain individually installable and maintain their own documentation.
- For production use, ensure your token and domain are correctly configured via the Face‑Auth dashboard.
Documentation
Website: https://face-auth.me
