Skip to content

Commit

Permalink
add npm entry point
Browse files Browse the repository at this point in the history
  • Loading branch information
iamlacroix committed Mar 5, 2014
1 parent a40875b commit c3eea76
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,20 @@ Use the repository hook:
bower install https://github.com/toddmotto/fluidvids.git
```

## Installing with [browserify](https://github.com/substack/node-browserify)
Use the repository hook:

```
npm install toddmotto/fluidvids
```

Then require `fluidvids` in your file:

```javascript
// Note that it is called as a function.
var fluidvids = require('fluidvids')();
```

## Manual installation
Ensure you're using the files from the `dist` directory (contains compiled production-ready code). Ensure you place the script before the closing `</body>` tag.

Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
},
"homepage": "github.com/toddmotto/fluidvids",
"version": "2.2.0",
"main": "dist/fluidvids.js",
"devDependencies": {
"grunt": "~0.4.1",
"grunt-contrib-concat": "~0.3.0",
Expand Down

0 comments on commit c3eea76

Please sign in to comment.