nativescript-security/README.md

Security NativeScript plugin.

# NativeScript Security plugin (w/ TypeScript)

iOS and Android fingerprint scanner for {N} apps.

## Installation

```
tns plugin add nativescript-security
```

## Usage

#### Check for availability

```typescript
import {Security} from 'nativescript-security';

let security = new Security();

let security.available().then(() => {
  
}).catch((error:any)=>{
  console.log(error);
});
```

#### Verify Fingerprint

```typescript
import {Security, FingerprintOptions} from 'nativescript-security';

let options:FingerprintOptions = {
  iOSMessage:'Your message:',
  androidTitle: 'Your title',
  androidMessage: 'Your message'
};

let security = new Security();

let security.verifyFingerPrint(options).then(() => {
  console.log('Verified OK');
}).catch((error) => {
  console.log(error);
});

```

## Future plans
- [ ] Detect if fingerprint has changed android/ios
- [ ] Store secret in android keystore / ios keychain