pg3d-autocorrect/README.md

Pixel Gun 3d Encyclopedia package helper(autocorrect)

## Usage

### Default options

````javascript
var pg3dautocorrect = require('pg3dautocorrect')()
autocorrect('extermator') // exterminator
````

### Custom dictionary path

````javascript
var path = '/usr/share/dict/words'
var pg3dautocorrect = require('pg3dautocorrect')({dictionary: path})
autocorrect('extermator') // exterminator
````

### Custom words
```` javascript
var words = ['pixelgun', 'antichampionrifle', 'laserbow']
var pg3dautocorrect = require('pg3dautocorrect')({words: words})
autocorrect('larbow') // laserbow
````

## Options

* `words` - a list of words to use for matching
* `dictionary` - path to dictionary file