center_image_tag 0.0.15 → 0.0.16

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MDAxYjU0NGI2ZjBlMDBjOWIxYmQwZjFmMzgzODZjYzc1ODRiNjllOA==
+    Nzc0YjI2Y2JiMjU5MzY4NjllNGU0N2MxYmQxZTE5MjE2ZDhlMTdhZg==
   data.tar.gz: !binary |-
-    MTJiNDljOWIyZDA0ZTUwYzIwYzQwY2FhZDg2NDNlNTQ1ODQxNGUzZQ==
+    ZmUzYzQwYzUyZGZhOGU1MjI0NWYyNGJmZDFmOGRhMmZkY2QzZDMxNQ==
 SHA512:
   metadata.gz: !binary |-
-    YjI0NzQ3MTM0NTI0NzdjNjdhOTYwMzY1MjcyNDg0N2Y1YzVjZDRkZjY4N2Qw
-    ZDI1OGJjNGNjN2Y5Y2Y4ZTdlY2I2YzkzMjVjMmQzMmM2MDI2MWRjMzE0ZDhj
-    NjRhM2Q2YjY4NWUzOWRiZjU3NThkMmUwNWIwNWYxOWU5M2ZlMzE=
+    ZWY5N2Q4MDRkN2RlNDY3ZTYwZjk4Njk0YjA1Yzg5MjUzNzI1NTJiZTNhNGY1
+    OGM3NzE4OWYxNjJlYjk1ZjM3MWI5ODg1NWY2NGZkMDg1ZTYzMjgzYTViYWQ3
+    MzI0NWJhMWMxOWRjMGQ1MzMzMDJlZjY2MGFhZmVlMDUwZmE5ZmE=
   data.tar.gz: !binary |-
-    NTk5YTkxMmY0MmU2ZmM2MTJkNWM4Y2E2Y2Y2OWIwZjNkNzUxOTg4ZGVlMTcz
-    OTJmNTZjZmYzOGZmMWQ0ZjY1YzhlYzk2NDI1NjQzZjU1ODFiM2EyNjBiODNi
-    MTc2NWNjMTczOTk2OTYzZTA1YTU4MWEyMTNjNzRmMzc1MzRkMmY=
+    NTU1ZWU0Y2U5ZDNmNTI5YWEzNmNhYmI1MGRlMjU2NTgzNDdhNmI5OTg4ZDcy
+    NzgyOWUxN2FiZmUzOTcwZDU4NmFkMWE5MDI4MDA4ZjU1YWJhMmFhMDk5ZTIz
+    ZTg3NzQ2ZjI5ZjFmNGFkYjkyZjJiMTA2NTVmYTk5MWE3Mjc4MWI=

data/README.md

@@ -1,8 +1,11 @@
+[![Gem Version](https://badge.fury.io/rb/center_image_tag.png)](http://badge.fury.io/rb/center_image_tag)
 [![Build Status](https://travis-ci.org/anhkind/center_image_tag.png)](https://travis-ci.org/anhkind/center_image_tag)
 
-# CenterImageTag
+# center_image_tag: Center your images with pure css
 
-TODO: Write a gem description
+`center_image_tag` is another tag helper for Rails app which helps to center your image in its parent element view. It has the same arguments as `image_tag`, so you can easily integrate this into your current Rails app.
+
+`center_image_tag` has a built-in fluid mode which would buy you some time to center the images in your responsive design. Otherwise, just set fixed width and height as in `image_tag`, you can also have images auto-centered with the set dimension.
 
 ## Installation
 
@@ -10,17 +13,69 @@ Add this line to your application's Gemfile:
 
     gem 'center_image_tag'
 
-And then execute:
 
-    $ bundle
+Then import `center_image_tag` in an SCSS file (for example, application.css.scss):
+
+    @import 'center_image_tag';
+
+## Options
+
+`center_image_tag` has the same options as `image_tag` helper and adds 2 more options to the option hash:
+
+  - `fluid`: set the image to be autoscaled with its parent. See 'Fluid mode' section below for details.
+  - `container_class`: css classes to the outer container of center_image_tag. See 'Container class' section below for details.
+
+## Modes of operation
+
+`center_image_tag` has 2 modes of operation which are mutually exclusive, i.e. can't use at the same time, so try to pick up the best mode that fits your need.
+
+### Fluid mode
+
+`center_image_tag` can display the image which will auto scale with its parent element. The percentage between height and width of the image needs to be set:
+
+```ruby
+center_image_tag 'http://yoursite/image.png', fluid: '56.25%'
+```
+
+### Fixed width and height mode
+`center_image_tag` can display the image whose width and height are fixed:
+
+```ruby
+center_image_tag 'http://yoursite/image.png', size: '200x100'
+```
+
+```ruby
+center_image_tag 'http://yoursite/image.png', size: '100'
+```
+
+```ruby
+center_image_tag 'http://yoursite/image.png', width: 200, height: 100
+```
+
+You can notice that these options are exactly the same as the `image_tag` helper.
+
+## Container class
+`center_image_tag` uses a nested `div` tags to make your image center. `container_class` option will help to add css classes to the outer container generated by `center_image_tag`, for example:
 
-Or install it yourself as:
+```ruby
+center_image_tag 'http://yoursite/image.png', fluid: '56.25%', container_class: 'my-custom-class'
+# => 
+# <div class="... my-custom-class">
+#   ...
+#   <img src="http://yoursite/image.png" />
+#   ...
+# </div>
+```
 
-    $ gem install center_image_tag
+With this option, it can help in the case you need to add more styles or override the current styles of the generated container, e.g. make the image inline.
 
-## Usage
+## Fallback
+In the case that
 
-TODO: Write usage instructions here
+  - `fluid' option is NOT set, AND
+  - both width and height are NOT set (throught `size` option or `width`/`height` options)
+  
+`center_image_tag` will fall back to normal `image_tag`
 
 ## Contributing
 

data/center_image_tag.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = CenterImageTag::VERSION
   spec.authors       = ["Anh Nguyen"]
   spec.email         = ["anhkind@gmail.com"]
-  spec.description   = "center_image_tag helps your Rails app to center your images easily."
-  spec.summary       = "Center your images without js."
+  spec.description   = "center_image_tag helps your Rails app to center your images easily with pure css."
+  spec.summary       = "Center your images with pure css."
   spec.homepage      = "https://github.com/anhkind/center_image_tag"
   spec.license       = "MIT"
 

data/lib/center_image_tag/version.rb

@@ -1,3 +1,3 @@
 module CenterImageTag
-  VERSION = "0.0.15"
+  VERSION = "0.0.16"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: center_image_tag
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.16
 platform: ruby
 authors:
 - Anh Nguyen
@@ -80,7 +80,8 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.12'
-description: center_image_tag helps your Rails app to center your images easily.
+description: center_image_tag helps your Rails app to center your images easily with
+  pure css.
 email:
 - anhkind@gmail.com
 executables: []
@@ -125,7 +126,7 @@ rubyforge_project:
 rubygems_version: 2.1.10
 signing_key: 
 specification_version: 4
-summary: Center your images without js.
+summary: Center your images with pure css.
 test_files:
 - spec/spec_helper.rb
 - spec/view_helper_spec.rb