diff --git a/.gitignore b/.gitignore index bbbfe88..5d25b48 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,4 @@ node_modules -bower_components coverage .DS_Store _site diff --git a/README.md b/README.md index e90d8d2..ac6007e 100644 --- a/README.md +++ b/README.md @@ -3,28 +3,23 @@ Categorize, sort, and filter a responsive grid of items. ```bash -npm install shufflejs --save +npm install shufflejs ``` -Shuffle is also available on bower as `shufflejs`. - ## Docs and Demos [All found here][homepage] -### Usage (with CommonJS) +### Usage (with ES6) ```js -var Shuffle = require('shufflejs'); +import Shuffle from 'shufflejs'; -var myShuffle = new Shuffle(document.getElementById('grid'), { +const 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/). diff --git a/_config.yml b/_config.yml index 123625a..32ce219 100644 --- a/_config.yml +++ b/_config.yml @@ -11,7 +11,6 @@ exclude: [ 'node_modules', 'src', 'test', - 'bower.json', 'CONTRIBUTING.md', 'gulpfile.js', 'README.md', diff --git a/_includes/changelog.html b/_includes/changelog.html index 315adc1..e018e03 100644 --- a/_includes/changelog.html +++ b/_includes/changelog.html @@ -1,5 +1,6 @@

Changes