README.md in artwork-0.1.0 vs README.md in artwork-0.1.1
- old
+ new
@@ -3,10 +3,12 @@
Automated user-resolution-based image size choosing for your Rails views, but
done at the backend. Works for any browser. Delivers the information needed for
the calculations (browser window's dimentions and device's pixel ratio) via a
cookie. Supports only Paperclip attachments.
+The gem should be thread-safe and should work with Rails 2.3 or newer.
+
## An example
Say you've declared a default (base) resolution of 1440px. You design based on
that resolution. You want to show the user an image which is half of the width
of the user's browser. You then add the following to your view:
@@ -26,9 +28,16 @@
You don't have that exact size on the server, so the helper will choose the
1024px-wide version of the image.
If the user's screen is retina (ie. with a device-to-pixel ratio > 1.0) and if
you have a _2x versions of your thumbs, the helper will choose the _2x one.
+
+## Requirements
+
+- Rails 2.3 or newer
+- Paperclip 2.3 or newer
+- jQuery
+- The jQuery.cookie plugin
## Installation
Add this line to your application's Gemfile: