Update readme

pull/111/head
Glen Cheney 8 years ago
parent 60cc0241b3
commit af4b92dde7

@ -1,17 +1,28 @@
# [Shuffle](http://vestride.github.io/Shuffle) [![Build Status](https://travis-ci.org/Vestride/Shuffle.svg?branch=master)](https://travis-ci.org/Vestride/Shuffle)
# [Shuffle](https://vestride.github.io/Shuffle) [![Build Status](https://travis-ci.org/Vestride/Shuffle.svg?branch=master)](https://travis-ci.org/Vestride/Shuffle)
Categorize, sort, and filter a responsive grid of items.
```bash
bower install shufflejs
npm install shufflejs
```
Shuffle is also available on NPM as `shufflejs`.
Shuffle is also available on bower as `shufflejs`.
## Docs and Demos
[All found here](http://vestride.github.io/Shuffle)
[All found here](https://vestride.github.io/Shuffle)
## Shuffle 3.0
Shuffle 3 is a big refactor from Shuffle 2. Enjoy!
### Usage (with CommonJS)
```js
var Shuffle = require('shuffle');
var myShuffle = new Shuffle(document.getElementById('grid'), {
itemSelector: '.js-item',
sizer: '.js-shuffle-sizer'
});
```
## Shuffle 4.0
Shuffle 4 removes jQuery as a dependency and is written in ES6.
## Inspiration
This project was inspired by [Isotope](http://isotope.metafizzy.co/) and [Packery](http://packery.metafizzy.co/).

Loading…
Cancel
Save