README.md in icheck-rails-0.9.0.2 vs README.md in icheck-rails-1.0.2.0
- old
+ new
@@ -1,19 +1,25 @@
+#### Please take a look at the excellent [rails-assets](https://rails-assets.org/) project before using this gem!
icheck-rails
=======================
+[](http://badge.fury.io/rb/icheck-rails)
+
[iCheck](http://damirfoy.com/iCheck/) is a library for creating super customized checkboxes and radio buttons with JQuery & Zepto.
This [Gem](http://rubygems.org/) packages iCheck for [Ruby](http://www.ruby-lang.org) on
[Rails'](http://rubyonrails.org/) [asset pipeline](http://guides.rubyonrails.org/asset_pipeline.html)
License: [MIT License](http://opensource.org/licenses/MIT) (just like iCheck)
Rails: 3.1 and up
-This gem's major and minor version reflects the version of iCheck it packages (currently iCheck 0.9 is packaged by icheck-rails 0.9.0.2)
+This gem's major and minor version reflects the version of iCheck it packages (currently iCheck 1.0.2 is packaged by icheck-rails 1.0.2.0)
+**Important**
+*If you are upgrading from iCheck version 0.9, the `jquery.icheck.js` and `zepto.icheck.js` files was removed and now it is just `icheck.js`*
+
## Installation
Add this line to your application's Gemfile:
gem 'icheck-rails'
@@ -28,20 +34,17 @@
Include the javascript part:
For Coffeescript
- #= require 'jquery.icheck'
+ #= require 'icheck'
For JavaScript
- //= require 'jquery.icheck'
+ //= require 'icheck'
-or if you want to use Zepto
- //= require 'zepto.icheck'
-
Be sure to include JQuery or Zepto before requiring iCheck.
Include the style part:
iCheck includes several skins, most of them with multiple color schemes. Include them like this:
@@ -90,7 +93,5 @@
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
-
-