<commit_before>VENTouchLock
=============
<!--  [![Build Status](https://travis-ci.org/venmo/VENTouchLock.svg?branch=master)](https://travis-ci.org/venmo/VENTouchLock) -->

VENTouchLock secures your app by requiring a Touch ID fingerprint scan or Passcode to gain access on launch and on background and is used in the Venmo app.

<!-- ![alt text](http://i.imgur.com/a1FfEBi.gif "VENTouchLock demo") -->

Installation
------------
The easiest way to get started is to use [CocoaPods](http://cocoapods.org/). Just add the following line to your Podfile:

```ruby
pod 'VENTouchLock', '~> 1.0'
```

Usage
-----

### 1. Create a Splash view controller
VENTouchLock requires a custom Splash view controller in order to hide the contents of your app during app-switch and present the Touch ID prompt and Passcode view controller. In order to create one, subclass ```VENTouchLockSplashViewController``` and override its ```init``` function with any customization. The Splash view controller is usually a good place to give your users the option to logout in case another user is attempting to sign in.

### 2. Start the framework
Add the VENTouchLock header file to your app delegate. Import this header in any of your implementation files to use the framework.
```obj-c
#import <VENTouchLock/VENTouchLock.h>
```
Add the following code to initialize VENTouchLock in your app delegate's ```application:didFinishLaunchingWithOptions:``` method.
```obj-c
[[VENTouchLock sharedInstance] setKeychainService:@"KEYCHAIN_SERVICE_NAME"
								  keychainAccount:@"KEYCHAIN_ACCOUNT_NAME"
                                    touchIDReason:@"TOUCHID_REASON"
                             passcodeAttemptLimit:ATTEMPT_LIMIT
                        splashViewControllerClass:[CUSTOM_SPLASH_VIEW_CONTROLLER class]];
```
<commit_msg>[README.md] Add sample images<commit_after>VENTouchLock
=============
<!--  [![Build Status](https://travis-ci.org/venmo/VENTouchLock.svg?branch=master)](https://travis-ci.org/venmo/VENTouchLock) -->

VENTouchLock secures your app by requiring a Touch ID fingerprint scan or Passcode to gain access on launch and on background and is used in the Venmo app.

<img src="http://i.imgur.com/Wt8yi6k.jpg" height="400px" /> <img src="http://i.imgur.com/g4Xrse9.gif" height="400px" />

Installation
------------
The easiest way to get started is to use [CocoaPods](http://cocoapods.org/). Just add the following line to your Podfile:

```ruby
pod 'VENTouchLock', '~> 1.0'
```

Usage
-----

### 1. Create a Splash view controller
VENTouchLock requires a custom Splash view controller in order to hide the contents of your app during app-switch and present the Touch ID prompt and Passcode view controller. In order to create one, subclass ```VENTouchLockSplashViewController``` and override its ```init``` function with any customization. The Splash view controller is usually a good place to give your users the option to logout in case another user is attempting to sign in.

### 2. Start the framework
Add the VENTouchLock header file to your app delegate. Import this header in any of your implementation files to use the framework.
```obj-c
#import <VENTouchLock/VENTouchLock.h>
```
Add the following code to initialize VENTouchLock in your app delegate's ```application:didFinishLaunchingWithOptions:``` method.
```obj-c
[[VENTouchLock sharedInstance] setKeychainService:@"KEYCHAIN_SERVICE_NAME"
								  keychainAccount:@"KEYCHAIN_ACCOUNT_NAME"
                                    touchIDReason:@"TOUCHID_REASON"
                             passcodeAttemptLimit:ATTEMPT_LIMIT
                        splashViewControllerClass:[CUSTOM_SPLASH_VIEW_CONTROLLER class]];
```

{'fraction_non_alphanumeric': 0.10709431910845338, 'fraction_numerical': 0.0051644468605599346, 'mean_word_length': 3.913217623497997, 'pattern_counts': {'":': 0, '<': 10, '<?xml version=': 0, '>': 12, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '153577', 'n_tokens_mistral': 1110, 'n_tokens_neox': 1003, 'n_words': 375}