Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sverigemeny committed Nov 2, 2012
1 parent 10851fd commit b1fd194
Showing 1 changed file with 2 additions and 62 deletions.
64 changes: 2 additions & 62 deletions README.md
@@ -1,63 +1,3 @@
fancybox-rails
==============
# Moved!

[![Build Status](http://travis-ci.org/hecticjeff/fancybox-rails.png)](http://travis-ci.org/hecticjeff/fancybox-rails)

Use [fancybox](http://www.fancyapps.com/fancybox/) with rails 3.1 asset pipeline.

## Installation

This gem vendors jquery fancybox 2 for Rails 3.1 and greater. The files
will be added to the asset pipeline and available for you to use.

First add the following lines to your applications `Gemfile`:

``` ruby
gem 'jquery-rails'
gem 'fancybox-rails'
```

Then run `bundle install` to update your application's bundle.

Now you need to edit your `app/assets/javascripts/application.js`
file and add the following line:

``` javascript
//= require jquery
//= require fancybox
```

And then edit your `app/assets/stylesheets/application.css` file to
look something like:

``` css
/*
*= require_self
*= require fancybox
*= require_tree .
*/
```

That's it!

## Usage

With the gem installed and included in your asset manifests, you can now
use fancybox as you normally would.

``` javascript
$(document).ready(function() {
$("a.fancybox").fancybox();
});
```

## More information

* [Contributors](https://github.com/hecticjeff/fancybox-rails/contributors)
* [DHH's RailsConf 2011 talk on the rails 3.1 asset pipeline](http://www.youtube.com/watch?v=cGdCI2HhfAU)

Copyright (c) Chris Mytton

## License

[Fancybox 2 license](http://www.fancyapps.com/fancybox/#license)
This gem has been moved to it's own repo & own gem over at https://github.com/kyparn/fancybox2-rails.

0 comments on commit b1fd194

Please sign in to comment.