README.md in retina_rails-0.1.3 vs README.md in retina_rails-1.0.0.beta1
- old
+ new
@@ -1,10 +1,10 @@
## Retina Rails
[](http://badge.fury.io/rb/retina_rails) [](http://travis-ci.org/jhnvz/retina_rails) [](https://coveralls.io/r/jhnvz/retina_rails) [](https://codeclimate.com/github/jhnvz/retina_rails) [](https://gemnasium.com/jhnvz/retina_rails)
-Makes your live easier optimizing an application for retina displays.
+Makes your life easier optimizing an application for retina displays.
How it works
------------
Retina Rails automatically generates retina versions of your uploaded images (CarrierWave or Paperclip). It detects if a visitor has a retina display and if so it displays the @2x version.
@@ -19,45 +19,73 @@
1. Add `//= require retina` to your Javascript manifest file (usually found at `app/assets/javascripts/application.js`).
CarrierWave
------------
-Add `include RetinaRails::CarrierWave` to the bottom of your uploader
+Simply add `retina!` to your uploader.
```ruby
class ExampleUploader < CarrierWave::Uploader::Base
+ retina!
+
version :small do
process :resize_to_fill => [30, 30]
process :retina_quality => 25
end
- include RetinaRails::CarrierWave
+ version :large, :retina => false do
+ process :resize_to_fill => [1000, 1000]
+ end
end
```
-By default it sets the retina image quality to 40 which can be overriden with `process :retina_quality => 25`
+By default it sets the retina image quality to 40 which can be overriden with `process :retina_quality => 25`. To disable the creation of a retina version simply call `version :small, :retina => false`.
+### Custom processors
+
+You can also use your custom processors like so:
+
+```ruby
+class ExampleUploader < CarrierWave::Uploader::Base
+
+ retina!
+
+ version :small, :retina => false do
+ process :resize_to_fill_with_gravity => [100, 100, 'North', :jpg, 75]
+ end
+
+ version :small_retina, :retina => false do
+ process :resize_to_fill_with_gravity => [200, 200, 'North', :jpg, 40]
+ end
+
+end
+```
+
+This will generate `small.jpg` and `small@2x.jpg`.
+
+
Paperclip
------------
-Add `include RetinaRails::Paperclip` to the bottom of your class
+Simply add `retina!` to your model and set `:retina` to true.
```ruby
class ExampleUploader < ActiveRecord::Base
+ retina!
+
has_attached_file :image,
:styles => {
:original => ["800x800", :jpg],
:big => ["125x125#", :jpg]
},
- :retina_quality => 25
+ :retina => true
+ # :retina => { :quality => 25 }
- include RetinaRails::Paperclip
-
end
```
-By default it sets the retina image quality to 40 which can be overriden by adding a `retina_quality` option
+By default it sets the retina image quality to 40 which can be overriden by adding a `quality` option.
For retina images use
------------
```ruby