From 34737962736f835f3cc06c770546c444cdc7e14b Mon Sep 17 00:00:00 2001 From: David DeSandro Date: Wed, 11 Apr 2012 17:38:52 -0400 Subject: [PATCH 1/2] README : GitHub markdown style --- README.mdown | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/README.mdown b/README.mdown index e033c8e..560afbe 100644 --- a/README.mdown +++ b/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,15 @@ 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 ---------- +## 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. From 43c3932dd37a0b487737c53ff9415589b01dc5d5 Mon Sep 17 00:00:00 2001 From: David DeSandro Date: Wed, 11 Apr 2012 17:39:20 -0400 Subject: [PATCH 2/2] README : add Isotope submodule --- README.mdown | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.mdown b/README.mdown index 560afbe..c737a33 100644 --- a/README.mdown +++ b/README.mdown @@ -31,6 +31,28 @@ jekyll --server --auto Then view the live site at [http://localhost:4000](http://localhost:4000). +## 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. @@ -53,4 +75,4 @@ View the [commit history](https://github.com/desandro/isotope/commits/master/jqu * * * -Copyright (c) 2011-2012 David DeSandro / Metafizzy LLC \ No newline at end of file +Copyright (c) 2011-2012 David DeSandro / Metafizzy LLC