WeScan

WeScan makes it easy to add scanning functionalities to your iOS app! It's modelled after UIImagePickerController, which makes it a breeze to use.

• Features
• Example
• Requirements
• Installation
• Usage
• Communication
• License

Features

• Live scanning of documents
• Edit detected rectangle
• Batch scanning

Example

Requirements

• Swift 4.0
• iOS 10.0+
• Xcode 9.x

Installation

Cocoapods

Carthage

Manually

Usage

1. Make sure that your ViewController conforms to the ImageScannerControllerDelegate protocol

class YourViewController: UIViewController, ImageScannerControllerDelegate {

2. Implement the delegate functions

// Somewhere on your ViewController that conforms to ImageScannerControllerDelegate
func imageScannerController(_ scanner: ImageScannerController, didFailWithError error: Error) {
    print(error)
}

func imageScannerController(_ scanner: ImageScannerController, didFinishScanningWithResults results: ImageScannerResults) {
    // Your ViewController is responsible for dismissing the ImageScannerController
    scanner.dismiss(animated: true, completion: nil)
}

func imageScannerControllerDidCancel(_ scanner: ImageScannerController) {
    // Your ViewController is responsible for dismissing the ImageScannerController
    scanner.dismiss(animated: true, completion: nil)
}

3. Simply present the ImageScannerController in your ViewController

// Somewhere on your ViewController
let scannerVC = ImageScannerController()
scannerVC.imageScannerDelegate = self
self.present(scannerVC, animated: true, completion: nil)

Communication

• If you found a bug, open an issue.
• If you have a feature request, open an issue.
• If you want to contribute, submit a pull request.

License

WeScan is available under the MIT license. See the LICENSE file for more info.