README.md

jQuery.popLockIt

A jQuery plugin that does...

For documentation, usage and examples please see http://zamiang.github.com/jquery.poplockit/

See this example using Placekitten

Usage

Download the production version or the development version.

Include required Javascripts

<script src="jquery.js"></script>
<script src="dist/poplockit.min.js"></script>

Create html like this

  <div id="feed">
    <article>
      <div class="column">Left</div>
      <div class="column">Center</div>
      <div class="column">Right</div>
    </article>
    ...
  </div>

Apply the popLockIt plugin

$('#feed').popLockIt({
  feedItems      : $('#feed > article'),
  columnSelector : '> .column',
  margin         : 90
});

Contributing

Contributions and pull requests are very welcome. Please follow these guidelines when submitting new code.

Modifying the code

1. Fork and clone the repo.
2. If needed: npm install -g grunt for Grunt
3. If needed: brew install phantomjs for PhantomJS
4. Run npm install to install dependencies
5. Run grunt (compiles coffeescripts and runs tests)
6. Run grunt watch while editing files to auto-compile coffeescripts and run tests
7. Make all changes in Coffeescript files, not JavaScript files.

Submitting pull requests

1. Add tests for the change you want to make. Run grunt jasmine to see if tests fail.
2. Run grunt to compile new dist and make sure nothing is broken
3. Submit a Pull Request using GitHub.