fv/README.md

FormVision is a node.js library for extracting data from scanned forms

# FormVision [![NPM version](https://badge.fury.io/js/fv.png)](http://badge.fury.io/js/fv) [![Dependency Status](https://david-dm.org/creatale/node-fv.png)](https://david-dm.org/creatale/node-fv) [![devDependency Status](https://david-dm.org/creatale/node-fv/dev-status.png)](https://david-dm.org/creatale/node-fv#info=devDependencies)

FormVision is a [node.js](http://nodejs.org) library for extracting data from scanned forms.

## Features

- Extract text, barcodes and checkboxes from images
- Specify expected region, type and validation for each field
- Supports incorporation of domain specific knowledge (wrong place, right data)
- Supports multiple transformations (half printed, half written, different offsets)
- Meant to cut red tape!

## Installation

    $ npm install fv

## Quick Start

Install `fv`, download [that image](https://github.com/creatale/node-fv/blob/master/test/data/m10-printed.png) and [that schema](https://github.com/creatale/node-fv/blob/master/test/data/m10-schema.json). Now run the command-line interface:

- Print raw data extracted from image (without matching).
    ```
coffee bin/cli.coffee --remove-red --lang=deu m10-printed.png
    ```

- Print form data extracted from image using the specified schema (with matching).
    ```
coffee bin/cli.coffee --remove-red --lang=deu --schema=m10-schema.json m10-printed.png
    ```

## What's next?

Here are some quick links to help you get started:

- [API Reference](https://github.com/creatale/node-fv/wiki/API)
- [Bug Tracker](https://github.com/creatale/node-fv/issues)

## License

Licensed under the incredibly [permissive](http://en.wikipedia.org/wiki/Permissive_free_software_licence) [MIT License](http://creativecommons.org/licenses/MIT/). Copyright © 2013-2014 Christoph Schulz.
Dependencies may be licensed differently.