Permalink
Browse files

Updating readme

  • Loading branch information...
1 parent e09fb3a commit daa0cda863b6ba2072694133c0cd3d87c9de02c4 @iloveitaly committed Jan 14, 2013
Showing with 27 additions and 20 deletions.
  1. +0 −20 README
  2. +27 −0 README.md
View
@@ -1,20 +0,0 @@
-Author: Troy Mcilvena
-Website: http://www.troymcilvena.com
-Twitter: @mcilvena
-
-See this pull request for the difference between this fork and the original
-https://github.com/mcilvena/jQuery-Retina-Display-Plugin/pull/2
-
-Usage:
-
-$(element).retina([<filename_suffix:default=-2x>]);
-
-Example:
-
-<script src="js/jquery.retina.js" type="text/javascript" charset="utf-8"></script>
-
-<script type="text/javascript">
- $(document).ready(function() {
- $('img.retina').retina();
- });
-</script>
View
@@ -0,0 +1,27 @@
+## jQuery Retina
+Retina images for your website. Main differences from [retinajs](http://retinajs.com) are:
+
+* You can select which images you want to retinify
+* Optionally retain origin image size
+* Configurable image suffix
+* jQuery dependency
+
+## Installation
+Download the zip from GitHub or install via bower:
+```
+bower install --save jquery.retina
+```
+## Usage
+
+```javascript
+$(element).retina({
+ save_size: false,
+ suffix: '-some-crazy-2x-suffix'
+});
+```
+
+## Authors
+
+* Michael Bianco
+* Original author: Troy Mcilvena, http://www.troymcilvena.com, @mcilvena
+

0 comments on commit daa0cda

Please sign in to comment.