Skip to content

Commit

Permalink
Add NPM installation instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
carlsednaoui committed May 31, 2014
1 parent e26e9d4 commit 6a9f97b
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,14 @@ Not sure what I mean by _provide value_? Here are a few ideas to get your creati

## Installation

- Download the [minified](build/ouibounce.min.js) or [unminified](build/ouibounce.js) script and include it on your page. Ouibounce is wrapped by a [umd wrapper](https://github.com/ForbesLindesay/umd), so if you are using _requirejs/amd_ or _commonjs/browserify_, it will still work fine.
- You can also get Ouibounce from [cdnjs.com](http://cdnjs.com/libraries/ouibounce/).
- Another option is to use Bower: `curl http://bower.herokuapp.com/packages/ouibounce`
You have a few options to choose from:

- Download the [minified](build/ouibounce.min.js) or [unminified](build/ouibounce.js) script and include it on your page
- Get Ouibounce from [cdnjs.com](http://cdnjs.com/libraries/ouibounce/)
- Use Bower: `curl http://bower.herokuapp.com/packages/ouibounce`
- Use NPM: `npm install git://github.com/carlsednaoui/ouibounce.git`

_Note_: Ouibounce is wrapped by a [umd wrapper](https://github.com/ForbesLindesay/umd), so if you are using _requirejs/amd_ or _commonjs/browserify_, it will still work fine.

## Usage

Expand Down

0 comments on commit 6a9f97b

Please sign in to comment.