dense
v0.0.1
Published
Retina images plugin for jQuery
Downloads
13
Readme
Dense.js
Dense is a jQuery plugin for serving retina-ready, high pixel ratio images with ease. Small, ease-to-adapt, yet very customizable and works cross-browser. With Dense, your content images get support for data-ratiox
attributes and Apple's retina image naming convention.
Install
Download package or install using Bower or NPM:
$ bower install dense
$ npm install dense
Usage
Using Dense is simple. Include the plugin and initialize its method:
<script src="jquery.js"></script>
<script src="dense.js"></script>
<script>
$('img').dense();
</script>
If you're using import
or require
:
require('dense/src/dense.js');
For more instructions and options see the documentation.
Build
Dense uses Grunt to run tasks. First make sure that you have all base dependencies installed by running npm in the repository's directory:
$ cd dense
$ npm install
After you have installed all dependencies, you will be able to run tasks using Grunt, like releasing, building, publishing and testing:
$ grunt [task]
Where the [task]
is one of test
, build
, jsdoc
or release
. Tasks jsdoc
and release:[major|minor|patch]
require Java in addition to the Node.js due to the use of JSDoc3.