diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 55104cd..85ac604 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,7 @@ +# Contributing + ## Submitting Issues + All bug reports and issues **require** a [reduced test case](https://css-tricks.com/reduced-test-cases/). Want to start a CodePen with a shuffle template? Use this: [http://codepen.io/pen?template=qrjOpX](http://codepen.io/pen?template=qrjOpX) @@ -8,7 +11,9 @@ Take a look at the GitHub [contributing guide](https://guides.github.com/activit Without a reduced test case, your issue may be closed. ## Running locally + This project uses [Jekyll](https://jekyllrb.com/). + * Head over to [their quickstart guide](https://jekyllrb.com/docs/quickstart/) to setup jekyll. * Install npm dependencies `npm install`. * Run `npm run watch` to rebuild, start the jekyll server, and watch for changes. diff --git a/README.md b/README.md index 422a59c..47ec4d6 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ npm install shufflejs ``` ## Docs and Demos + [All found here][homepage] ### Usage (with ES6) @@ -21,6 +22,7 @@ const shuffleInstance = new Shuffle(document.getElementById('grid'), { ``` ## Inspiration + This project was inspired by [Isotope](http://isotope.metafizzy.co/) and [Packery](http://packery.metafizzy.co/). [homepage]: https://vestride.github.io/Shuffle/