@regulaforensics/face-sdk/examples/capacitor/README.md

This is an npm module for Regula Face SDK. It allows you to easily compaire faces using your phone's camera.

# Regula Face SDK Capacitor demo application

## How to build demo application
1. Download or the clone current repository using the command `git clone https://github.com/regulaforensics/npm-face-sdk.git`.

2. Execute `npm run setup` within this directory.

3. Run the app: 
  * IOS: `npm run ios`.
  * Android: `npm run android`.

**Note**: this is just one way of running the app. You can also pass `-o` or `--open` argument to the command, and this will open Xcode/Android Studio, then run the app directly from the IDE. Overall, this is a more consistent way, so if you're having troubles running the app from terminal, try running it from the IDE.


## How to use offline match
1. Place a license that supports offline match at `public/assets/regula.license`.

2. Change core with the following commands:
```bash
npm uninstall @regulaforensics/face-core-basic
npm install @regulaforensics/face-core-match
```

3. Turn off the internet and run the app.