Skip to content

Commit

Permalink
Proeject descirption
Browse files Browse the repository at this point in the history
  • Loading branch information
NiklasMerz committed Sep 3, 2016
1 parent 1f29d9a commit 3472bef
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 7 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,23 @@
# Cordova Plugin Fingerprint All-In-One
## **A**ndroid and **IO**s

[![npm version](https://badge.fury.io/js/cordova-plugin-fingerprint-aio.svg)](https://badge.fury.io/js/cordova-plugin-fingerprint-aio)
[![GitHub version](https://badge.fury.io/gh/niklasmerz%2Fcordova-plugin-fingerprint-aio.svg)](https://badge.fury.io/gh/niklasmerz%2Fcordova-plugin-fingerprint-aio)
[![CircleCI](https://circleci.com/gh/NiklasMerz/cordova-plugin-fingerprint-aio.svg?style=shield)](https://circleci.com/gh/NiklasMerz/cordova-plugin-fingerprint-aio)

This plugin is my attempt to provide a single interface for accessing fingerprint hardware on both Android 6+ and iOS.

There are some great cordova plugins out there that make use of the fingerprint APIs provided by Android and iOS. But I could not find a project which supports both platforms (correct me if I am wrong). So I decided to take the native code and bundle it together in one plugin.

## Disclaimer
This is just an simpler implementation of the original plugins. At the moment the API could change every day and the plugin build could crash or have secutity issues. If you use fingerprint authentication in production use the plugins below.

## Thanks to the authors of the original fingerprint plugins:

https://github.com/mjwheatley/cordova-plugin-android-fingerprint-auth

https://github.com/EddyVerbruggen/cordova-plugin-touch-id

## Work in Progress
Use with caution at the moment. Still under development..

Expand All @@ -16,12 +27,6 @@ ngCordova support planed for the future.
Android authentication seems to be working fine with the demo app (see below). iOS needs to tested ( lack of Apple hardware).
The API is still in a constant stage of change but it will be similar to the implementation of Matthew Wheatley (@mjwheatly).

## Thanks to the authors of the original fingerprint plugins:

https://github.com/mjwheatley/cordova-plugin-android-fingerprint-auth

https://github.com/EddyVerbruggen/cordova-plugin-touch-id

## How to use

For now refer to my demo app: https://github.com/NiklasMerz/fingerprint-aio-demo
4 changes: 3 additions & 1 deletion circle.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,14 @@ machine:
PATH: $PATH:$HOME/$CIRCLE_PROJECT_REPONAME/node_modules/.bin
dependencies:
override:
- sudo npm install -g ionic
- sudo npm install -g cordova
- npm install
test:
pre:
- emulator -avd test -no-audio -no-window:
background: true
parallel: true
- circle-android wait-for-boot
#- circle-android wait-for-boot
override:
- cordova-paramedic --platform android --plugin .

0 comments on commit 3472bef

Please sign in to comment.