README.md in shadowbox-rails-0.0.2 vs README.md in shadowbox-rails-0.0.3
- old
+ new
@@ -1,25 +1,41 @@
-# Shadowbox::Rails
+# Shadowbox for Rails 3.x
-TODO: Write a gem description
+Include the lightbox effect from shadowbox to your photos, videos, flash, etc. This gem will include the latest shadowbox.js, shadowbox.css and shadowbox required images to your assets pipeline so it's ready for deploy.
## Installation
+### Add the gem
+
Add this line to your application's Gemfile:
gem 'shadowbox-rails'
And then execute:
- $ bundle
+ bundle
Or install it yourself as:
- $ gem install shadowbox-rails
+ gem install shadowbox-rails
+### Add Shadowbox to the asset pipeline like usual
+
+#### application.js
+
+ require shadowbox
+
+#### application.css.scss
+
+ @import 'shadowbox';
+
## Usage
-TODO: Write usage instructions here
+ Add rel='shadowbox' to links where the href is your full size image like this:
+ link_to 'Test me!', asset_path('path_to_my_img.jpg'), rel: 'shadowbox'
+
+ Go to http://www.shadowbox-js.com/ for more details.
+
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)