# sift

  Fast String Distance (SIFT) Algorithm.

[![NPM](https://nodei.co/npm/sift-string.png)](https://nodei.co/npm/sift-string/)

[![Dependency Status](https://david-dm.org/timoxley/sift.png)](https://david-dm.org/timoxley/sift)

## Installation

#### Browserify/Node

    $ npm install sift-string


#### Component

    $ component install timoxley/sift

## Demo

[Demo](http://timoxley.github.com/sift/examples/spellcheck/)

or if you want to check it out locally:

```bash
# run only once to install npm dev dependencies
npm install .
# this will install && build the components and open the demo web page
npm run c-demo
```

## API

### sift(string, string)

Return 'distance' between two strings.

## TODO

* Dictionary Helper supply it emits suggestions.

## Credit

Code extracted from [MailCheck](https://github.com/kicksend/mailcheck)

## License

  MIT