Skip to content

refactor: improve plugin intro #633

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 13, 2025
Merged

refactor: improve plugin intro #633

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
95c24e9
refactor: improve plugin intro
Ombuweb Jun 12, 2025
ae314b9
Merge branch 'main' into patch-2
NathanWalker Jun 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions packages/biometrics/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,13 @@ A plugin that allows you to authenticate users with biometrics, such as fingerpr
> **Note**
This plugin replaces [@nativescript/fingerprint-auth](../fingerprint-auth).

### Prerequisites:
Before you can verify a user’s biometrics, the device must already have biometric data (such as fingerprints or a face scan) enrolled at the system level. This enrollment is handled by the device’s operating system settings—your app or this plugin does not capture or store biometric data directly. Users must set up biometrics through their device’s security settings (e.g., `Settings` > `Security` > `Biometrics` on Android, or `Settings` > `Face ID` & `Passcode` on iOS).

### How it works:
When you call the plugin’s verification methods, the plugin asks the operating system to prompt the user for their enrolled biometric (fingerprint, face, etc.) and returns the result. The plugin never sees or manages the actual biometric data—only the OS does.


## Installation

```cli
Expand Down