Browse Source

📝 update README for v3; .mdown -> .md

pull/1127/head
David DeSandro 9 years ago
parent
commit
5cc2273851
  1. 26
      README.md
  2. 2
      gulpfile.js

26
README.mdown → README.md

@ -8,25 +8,25 @@ See [isotope.metafizzy.co](http://isotope.metafizzy.co) for complete docs and de
### Download ### Download
+ [isotope.pkgd.js](https://github.com/metafizzy/isotope/raw/master/dist/isotope.pkgd.js) un-minified, or + [isotope.pkgd.js](https://npmcdn.com/isotope-layout@3/dist/isotope.pkgd.js) un-minified, or
+ [isotope.pkgd.min.js](https://github.com/metafizzy/isotope/raw/master/dist/isotope.pkgd.min.js) minified + [isotope.pkgd.min.js](https://npmcdn.com/isotope-layout@3/dist/isotope.pkgd.min.js) minified
### CDN ### CDN
Link directly to [Isotope files on cdnjs](https://cdnjs.com/libraries/jquery.isotope). Link directly to [Isotope files on cdnjs](https://cdnjs.com/libraries/jquery.isotope).
``` html ``` html
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery.isotope/2.2.2/isotope.pkgd.js"></script> <script src="https://npmcdn.com/isotope-layout@3.0/dist/isotope.pkgd.min.js"></script>
<!-- or --> <!-- or -->
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery.isotope/2.2.2/isotope.pkgd.min.js"></script> <script src="https://npmcdn.com/isotope-layout@3.0/dist/isotope.pkgd.js"></script>
``` ```
### Package managers ### Package managers
Bower: `bower install isotope --save`
npm: `npm install isotope-layout --save` npm: `npm install isotope-layout --save`
Bower: `bower install isotope --save`
## License ## License
### Commercial license ### Commercial license
@ -69,23 +69,17 @@ var iso = new Isotope( grid, {
With HTML With HTML
Add a class of `js-isotope` to your element. Options can be set in JSON in `data-isotope-options`. Add a `data-isotope` attribute to your element. Options can be set in JSON in the value.
``` html ``` html
<div class="grid js-isotope" <div class="grid"
data-isotope-options='{ "itemSelector": ".grid-item", "masonry": { "columnWidth": 200 } }'> data-isotope='{ "itemSelector": ".grid-item", "masonry": { "columnWidth": 200 } }'>
<div class="grid-item"></div> <div class="grid-item"></div>
<div class="grid-item"></div> <div class="grid-item"></div>
... ...
</div> </div>
``` ```
## Support
[CodersClan has a dedicated support forum for Isotope](https://www.codersclan.net/?repo_id=1), where you can get personal support from experienced developers.
#### [Get support on CodersClan](https://www.codersclan.net/?repo_id=1)
* * * * * *
By [Metafizzy](http://metafizzy.co) By [Metafizzy](http://metafizzy.co), 2010–2016

2
gulpfile.js

@ -122,7 +122,7 @@ gulp.task( 'version', function() {
.pipe( gulp.dest('.') ); .pipe( gulp.dest('.') );
// replace CDN links in README // replace CDN links in README
var minorVersion = version.match( /^\d\.\d+/ )[0]; var minorVersion = version.match( /^\d\.\d+/ )[0];
gulp.src('README.mdown') gulp.src('README.md')
.pipe( replace( /isotope-layout@\d\.\d+/g, 'isotope-layout@' + minorVersion )) .pipe( replace( /isotope-layout@\d\.\d+/g, 'isotope-layout@' + minorVersion ))
.pipe( gulp.dest('.') ); .pipe( gulp.dest('.') );
}); });

Loading…
Cancel
Save