@regulaforensics/face-sdk/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 plugin
Face SDK is a framework that is used for face matching, recognition and liveness detection.
This plugin makes possible to use it with react-native, cordova and ionic applications.

## Demo applications
In the [examples](examples/) folder you can find 4 demo applications:
* [React-native](examples/react_native)
* [Cordova](examples/cordova)
* [Ionic(ionic app with cordova, angular)](examples/ionic)
* [Capacitor(ionic app with capacitor, react)](examples/capacitor)

Each demo app has its own readme file with instructions on building and installation.

## Documentation
* [Documentation](https://docs.regulaforensics.com/develop/face-sdk/mobile)
* [API Reference](https://dev.regulaforensics.com/npm-face-sdk)

## Support
If you have any technical questions, feel free to [contact](mailto:support@regulaforensics.com) us or create issues [here](https://github.com/regulaforensics/npm-face-sdk/issues).