Commit 5a0d47af authored by David DeSandro's avatar David DeSandro
Browse files

better README

parent e5791a89
Showing with 26 additions and 1 deletion
+26 -1
# Packery
_Uncanny layout library_
_Bin-packing layout library_
## Install
Install with [Bower](https://github.com/twitter/bower).
......@@ -8,6 +10,16 @@ Install with [Bower](https://github.com/twitter/bower).
bower install packery
```
## Commercial license
Packery may be used in commercial projects and applications with the one-time purchase of a commercial license. If you are paid to do your job, and part of your job is implementing Packery, a commercial license is required.
Use in non-commercial, personal, or open-source applications is free.
## Initialize
### in JavaScript
``` js
var container = document.querySelector('#container');
var myPackery = new Packery( container, {
......@@ -15,3 +27,16 @@ var myPackery = new Packery( container, {
});
```
### in HTML
Add a class of `js-packery` to your element. Options can be set in JSON in `data-packery-options`.
``` html
<div class="js-packery" data-packery-options='{ "itemSelector": ".item" }'>
...
</div>
```
---
Copyright (c) 2013 Metafizzy
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment