<commit_before>![Demo](https://github.com/charlymr/IRLDocumentScanner/blob/master/Medias/iphone-scan.gif?raw=true)

# IRLDocumentScanner

IRLDocumentScanner is an Objective-C ViewController that will Automatically scan a document for you you.
**MINIMUM iOS REQUIREMENT: 8.0**

[![Build Status](https://travis-ci.org/charlymr/IRLDocumentScanner.svg?branch=master)](https://travis-ci.org/charlymr/IRLDocumentScanner)[![Version](https://img.shields.io/cocoapods/v/IRLDocumentScanner.svg?style=flat)](http://cocoapods.org/pods/IRLDocumentScanner)[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)[![Platform](https://img.shields.io/cocoapods/p/IRLDocumentScanner.svg?style=flat)](http://cocoapods.org/pods/IRLDocumentScanner)

![Screenshot](https://github.com/charlymr/IRLDocumentScanner/blob/master/Medias/scan.jpg?raw=true)

## Application plist requirement (iOS 10+)

As of iOS 10, you must povide a reason for using thre camera in you plist:
Please add the follwing to your plist:
**NSCameraUsageDescription : We need the camera to scan**

## Installation

The recommended approach for installing IRLDocumentScanner is via the [CocoaPods](http://cocoapods.org/) package manager, as it provides flexible dependency management and dead simple installation. For best results, it is recommended that you install via CocoaPods **>= 1.0** using Git **>= 1.8.0** installed via Homebrew.

### via CocoaPods

Install CocoaPods if not already available:

``` bash
$ [sudo] gem install cocoapods
$ pod setup
```

Change to the directory of your Xcode project, and Create and Edit your Podfile and add IRLDocumentScanner:

``` bash
$ cd /path/to/MyProject
$ touch Podfile
$ edit Podfile
platform :ios, '8.0'
pod 'IRLDocumentScanner'
```

### via Carthage

Install [Carthage](https://github.com/Carthage/Carthage#installing-carthage) if not already available 

Change to the directory of your Xcode project, and Create and Edit your Podfile and add IRLDocumentScanner:

``` bash
$ cd /path/to/MyProject
$ touch CartFile
$ edit CartFile

github "charlymr/IRLDocumentScanner" ~> 0.3.0
```

Save and run:
``` bash
$ carthage update
```

Drop the Carthage/Build/iOS .framework in your project.

For more details on Cartage and how to use it, check the [Carthage Github](https://github.com/Carthage/Carthage) documentation


### Manually<commit_msg>Readme update<commit_after>![Demo](https://github.com/charlymr/IRLDocumentScanner/blob/master/Medias/iphone-scan.gif?raw=true)

# IRLDocumentScanner

IRLDocumentScanner is an Objective-C ViewController that will Automatically scan a document for you you.
**MINIMUM iOS REQUIREMENT: 8.0**

[![Build Status](https://travis-ci.org/charlymr/IRLDocumentScanner.svg?branch=master)](https://travis-ci.org/charlymr/IRLDocumentScanner)[![Version](https://img.shields.io/cocoapods/v/IRLDocumentScanner.svg?style=flat)](http://cocoapods.org/pods/IRLDocumentScanner)[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)[![Platform](https://img.shields.io/cocoapods/p/IRLDocumentScanner.svg?style=flat)](http://cocoapods.org/pods/IRLDocumentScanner)

![Screenshot](https://github.com/charlymr/IRLDocumentScanner/blob/master/Medias/scan.jpg?raw=true)

## Application plist requirement (iOS 10+)

As of iOS 10, you must povide a reason for using thre camera in you plist:
Please add the follwing to your plist:
**NSCameraUsageDescription : We need the camera to scan**

## Installation

The recommended approach for installing IRLDocumentScanner is via the [CocoaPods](http://cocoapods.org/) package manager, as it provides flexible dependency management and dead simple installation. For best results, it is recommended that you install via CocoaPods **>= 1.0** using Git **>= 1.8.0** installed via Homebrew.

### via CocoaPods

Install CocoaPods if not already available:

``` bash
$ [sudo] gem install cocoapods
$ pod setup
```

Change to the directory of your Xcode project, and Create and Edit your Podfile and add IRLDocumentScanner:

``` bash
$ cd /path/to/MyProject
$ touch Podfile
$ edit Podfile

platform :ios, '8.0'

target "YOUR APP" do
pod 'IRLDocumentScanner'
use_frameworks!
end

```

### via Carthage

Install [Carthage](https://github.com/Carthage/Carthage#installing-carthage) if not already available 

Change to the directory of your Xcode project, and Create and Edit your Podfile and add IRLDocumentScanner:

``` bash
$ cd /path/to/MyProject
$ touch CartFile
$ edit CartFile

github "charlymr/IRLDocumentScanner" ~> 0.3.1
```

Save and run:
``` bash
$ carthage update
```

Drop the Carthage/Build/iOS .framework in your project.

For more details on Cartage and how to use it, check the [Carthage Github](https://github.com/Carthage/Carthage) documentation


### Manually
{'fraction_non_alphanumeric': 0.1212556421830119, 'fraction_numerical': 0.007796471070988921, 'mean_word_length': 5.508678237650201, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 9, 'https://': 20, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6009297', 'n_tokens_mistral': 1682, 'n_tokens_neox': 1589, 'n_words': 422}