diff options
Diffstat (limited to 'node_modules/meant/README.md')
| -rw-r--r-- | node_modules/meant/README.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/node_modules/meant/README.md b/node_modules/meant/README.md index 6c541ce9c..90cc0ac77 100644 --- a/node_modules/meant/README.md +++ b/node_modules/meant/README.md @@ -2,6 +2,17 @@ Like the `Did you mean?` in git for npm +## API +### meant(item, list) ++ item {String} A key for finding an approximate value ++ list {Array} A list for comparing with the item + +```js +const meant = require('meant') +const result = meant('foa', ['foo', 'bar', 'baz']) +// => [ 'foo' ] +``` + ## Installation Download node at [nodejs.org](http://nodejs.org) and install it, if you haven't already. |