Skip to content

Commit

Permalink
Badges in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
eklem committed Jun 16, 2020
1 parent 6052dc6 commit 25eb3f2
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@ Return all word matches between two arrays within given Levenshtein distance.

Intended use is to return all words in a query that has matches in an index within a given Levenshtein distance. Good for autocomplete type functionality, and in some cases also searching.

[![NPM version][npm-version-image]][npm-url]
[![NPM downloads][npm-downloads-image]][npm-url]
[![MIT License][license-image]][license-url]
[![Build Status][travis-image]][travis-url]
[![JavaScript Style Guide][standardjs-image]][standardjs-url]

## Use
```javaScript
const lvm = require('../index.js')
Expand All @@ -13,4 +19,15 @@ lvm.levenMatch(query, index, {distance: 2})
//[ [ 'query' ], [ 'word', 'words' ], [ 'levenshtein' ] ]
```

Returns an array of arrays. One sub-array for each query word.
Returns an array of arrays. One sub-array for each query word.


[license-image]: http://img.shields.io/badge/license-MIT-blue.svg?style=flat
[license-url]: LICENSE
[npm-url]: https://npmjs.org/package/leven-match
[npm-version-image]: https://img.shields.io/npm/v/leven-match.svg?style=flat
[npm-downloads-image]: https://img.shields.io/npm/dm/leven-match.svg?style=flat
[travis-url]: https://travis-ci.org/eklem/leven-match
[travis-image]: https://img.shields.io/travis/eklem/leven-match.svg?style=flat
[standardjs-url]: https://standardjs.com
[standardjs-image]: https://img.shields.io/badge/code_style-standard-brightgreen.svg?style=flat-square

0 comments on commit 25eb3f2

Please sign in to comment.