artwork 0.0.1 → 0.1.0

data/README.md

@@ -1,13 +1,33 @@
 # Artwork
 
-Automated image size scaling view helpers for your frontend, but done in the
-backend. Works for any browser. Delivers the information needed for the
-calculations (browser window's dimentions and device's pixel ratio) via a
+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.
 
-Example usage:
+## An example
 
-    <%= artwork_tag person, :avatar, '100x' %>
+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:
+
+    <%= artwork_tag @post, :cover_image, '720x' %>
+
+Say you have the following image thumbs prepared (defined with imagemagick
+geometry strings):
+
+    256x>
+    512x>
+    1024x>
+    2048x>
+
+Let's also assume a user with a full HD screen opens your page (1920x1080).
+Then, `artwork_tag` will look for a 960px wide image (which is 50% of 1920px).
+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.
 
 ## Installation
 
@@ -67,8 +87,8 @@ Configure the gem by putting the following code in `config/initializers/artwork.
 
 Include `Artwork::Model` in your models which have artworks.
 
-Include `Artwork::Model` in your `ApplicationController` or wherever you want
-to have the artwork functionality.
+Include `Artwork::Controller` in your `ApplicationController` or wherever you
+want to have the artwork functionality.
 
 Then you can use `Artwork.load_2x_images?`, `Artwork.current_resolution` and
 the `artwork_tag` view helper. Example:
@@ -78,7 +98,7 @@ the `artwork_tag` view helper. Example:
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/artwork/fork )
+1. [Fork it](https://github.com/mitio/artwork/fork)
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/artwork.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |spec|
   spec.version       = Artwork::VERSION
   spec.authors       = ['Dimitar Dimitrov']
   spec.email         = ['dimitar@live.bg']
-  spec.summary       = 'Automated image size scaling view helpers.'
-  spec.description   = 'Works for any browser and uses cookies for transporting browser info to the backend.'
-  spec.homepage      = ''
+  spec.summary       = 'Automated user resolution based image size choosing for Rails.'
+  spec.description   = 'Automated user resolution based image size choosing for your Rails views, but done at the backend.'
+  spec.homepage      = 'https://github.com/mitio/artwork'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")

data/lib/artwork/version.rb

@@ -1,3 +1,3 @@
 module Artwork
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: artwork
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Dimitar Dimitrov
@@ -77,7 +77,7 @@ dependencies:
         version: "2.3"
   type: :runtime
   version_requirements: *id004
-description: Works for any browser and uses cookies for transporting browser info to the backend.
+description: Automated user resolution based image size choosing for your Rails views, but done at the backend.
 email: 
 - dimitar@live.bg
 executables: []
@@ -104,7 +104,7 @@ files:
 - lib/artwork/view.rb
 - lib/assets/javascripts/artwork.js
 has_rdoc: true
-homepage: ""
+homepage: https://github.com/mitio/artwork
 licenses: 
 - MIT
 post_install_message: 
@@ -136,6 +136,6 @@ rubyforge_project:
 rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: Automated image size scaling view helpers.
+summary: Automated user resolution based image size choosing for Rails.
 test_files: []