Skip to content

Commit

Permalink
Add installation instructions to Readme.md (#327)
Browse files Browse the repository at this point in the history
I copied these instructions from fusejs.io but chose to put NPM first;
NPM is the recommended installation method and Github users are
arguably more likely to use it than website-only users.
  • Loading branch information
dorian-marchal authored and krisk committed Aug 30, 2019
1 parent fe1ff83 commit 0aa34e0
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,21 @@ Fuse.js is a lightweight fuzzy-search, in JavaScript, with zero dependencies.

To checkout out [live examples](https://fusejs.io) and docs, visit [fusejs.io](https://fusejs.io).

## Installation

__NPM__

NPM is the recommended installation method. It pairs nicely with a CommonJS module bundler such as [Webpack](http://webpack.github.io/) or [Browserify](http://browserify.org/).

```sh
# latest stable
$ npm install --save fuse.js
```

__CDN__

Available on [cdnjs](https://cdnjs.cloudflare.com/ajax/libs/fuse.js/3.4.5/fuse.min.js) (see the latest version on [the Releases page](https://github.com/krisk/Fuse/releases)).

## Contributing

### Coding conventions
Expand Down

0 comments on commit 0aa34e0

Please sign in to comment.