Browse Source

Merge branch 'master' into gh-pages

v1
David DeSandro 13 years ago
parent
commit
2b120e5b5f
  1. 41
      README.mdown

41
README.mdown

@ -7,15 +7,13 @@ This package has all the documentation and demos to get you started.
View this project live at [http://isotope.metafizzy.co](http://isotope.metafizzy.co).
Licensing
---------
## Licensing
**Commercial use requires purchase of one-time license fee per developer seat.** Commercial use includes any application that makes you money. This includes portfolio sites and premium templates. Commercial licenses may be purchased at [http://metafizzy.co#licenses](http://metafizzy.co#licenses).
Use in non-commercial and personal applications is free.
Viewing this project locally
----------------------------
## Viewing this project locally
### Via download
@ -25,14 +23,37 @@ You can download a zip of all the flat HTML files from [http://meta.metafizzy.co
The documentation and demo pages are generated using [Jekyll](http://github.com/mojombo/jekyll/wiki). With Jekyll installed, you can clone this repo and run Jekyll from Terminal:
git clone https://github.com/desandro/isotope.git
cd isotope/
jekyll --server --auto
``` bash
git clone https://github.com/desandro/isotope.git
cd isotope/
jekyll --server --auto
```
Then view the live site at [http://localhost:4000](http://localhost:4000).
Changelog
---------
## Including Isotope as a submodule
The _module_ branch has just `jquery.isotope.js` and `jquery.isotope.min.js`, perfect for adding to your repo as a [submodule](http://dropshado.ws/post/20058825150/git-submodules).
``` bash
git submodule add https://github.com/desandro/isotope.git
cd isotope/
git checkout module
git pull origin module
cd ../
git submodule update --init
```
Then you can reference `isotope/jquery.isotope.min.js` within your own project.
To pull in the lastest version of the isotope submodule:
``` bash
cd isotope/
git pull origin module
```
## Changelog
View the [commit history](https://github.com/desandro/isotope/commits/master/jquery.isotope.js) for a complete robust list of changes to the script.
@ -54,4 +75,4 @@ View the [commit history](https://github.com/desandro/isotope/commits/master/jqu
* * *
Copyright (c) 2011-2012 David DeSandro / Metafizzy LLC
Copyright (c) 2011-2012 David DeSandro / Metafizzy LLC

Loading…
Cancel
Save