# hisrc-rails [![Build Status](https://travis-ci.org/haihappen/hisrc-rails.png?branch=master)](https://travis-ci.org/haihappen/hisrc-rails)

Retina displays are coming! Be sure to make your Rails app ready today.

How? Well, there are a lot of different approaches: 
* http://css-tricks.com/which-responsive-images-solution-should-you-use/
* http://www.alistapart.com/articles/responsive-images-how-they-almost-worked-and-what-we-need/

The one I like the most is [HiSRC](https://github.com/teleject/hisrc). However I don't like stuffing JavaScript files into my `vendor/assets` folder, so I created this gem with following benefits:

* It adds HiSRC to the Rails assets pipeline – no more messing around with javascript files (and a clean `vendor/assets` folder).
* It provides a little helper method to include retina ready images in your Rails views.

## Installation

In your `Gemfile`:

```ruby
gem 'hisrc-rails'
```

In your `application.js`:

```js
//= require hisrc

$(function() {
  $('img').hisrc();
});
```

For detailed information about available configuration options be sure to checkout the [HiSRC readme](https://github.com/teleject/hisrc#setting-up).

## Usage

This gem provides a nice little helper method to optimize your views for retina screens: `responsive_image_tag`

`responsive_image_tag` accepts the same options as `image_tag`, and two additional options as well:

* `:'1x'` - If no 1x option is provided, the `src` is used.
* `:'2x'` - If no 2x options is provided, "@2x" is added to the `src`. So "rails.png" becomes "rails@2x.png".

## Examples
```ruby
responsive_image_tag("rails.png")
# => <img src="/assets/rails.png" data-1x="/assets/rails.png" data-2x="/assets/rails@2x.png" />

responsive_image_tag("http://placehold.it/100x100", :'1x' => "http://placehold.it/200x200", :'2x' => "http://placehold.it/400x400")
# => <img src="http://placehold.it/100x100" data-1x="http://placehold.it/200x200" data-2x="http://placehold.it/200x200" />
```

## Acknowledgements
Many thanks to [1Mark](https://github.com/1Marc) for [his first version](https://github.com/1Marc/hisrc) of HiSRC, and to [teleject](https://github.com/teleject) for maintaining the [current version](https://github.com/teleject/hisrc) of this really great jQuery plugin. :)

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

## Copyright

(The MIT license)

Copyright (c) 2012 - 2013 Mario Uher

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.