Muriel-Salvan/rails-ajax

{<img src="https://badge.fury.io/rb/rails-ajax.png" alt="Gem Version" />}[http://badge.fury.io/rb/rails-ajax]
{<img src="http://inch-ci.org/github/Muriel-Salvan/rails-ajax.png" alt="Inline docs" />}[http://inch-ci.org/github/Muriel-Salvan/rails-ajax]
{<img src="https://travis-ci.org/Muriel-Salvan/rails-ajax.png?branch=master" />}[https://travis-ci.org/Muriel-Salvan/rails-ajax]
{<img src="https://codeclimate.com/github/Muriel-Salvan/rails-ajax.png" />}[https://codeclimate.com/github/Muriel-Salvan/rails-ajax]
{<img src="https://codeclimate.com/github/Muriel-Salvan/rails-ajax/coverage.png" />}[https://codeclimate.com/github/Muriel-Salvan/rails-ajax]
{<img src="https://gemnasium.com/Muriel-Salvan/rails-ajax.svg" alt="Dependency Status" />}[https://gemnasium.com/Muriel-Salvan/rails-ajax]
{<img src="https://pledgie.com/campaigns/24808.png?skin_name=chrome" alt="Click here to lend your support to: rails-ajax and make a donation at pledgie.com !" border="0" />}[https://pledgie.com/campaigns/24808]

= Rails-Ajax

<b>Integrate Ajax capabilities to Rails websites with history, bookmarking, partial refreshes, Rails flashes, user callbacks, scripts execution, redirections.</b>

Rails-Ajax is a <b>Rails plugin</b> that turns a static <b>Rails website into an optimized one using Ajax</b>, <b>without altering the user experience</b> and with minimal code changes.

== Basic install

rails-ajax is packaged as a Ruby gem. Use it in your Rails project by adding it to your Gemfile:

 gem 'rails-ajax'

== Basic usage

=== Generate configuration files

Once installed, some configuration files need to be generated:

 rake rails-ajax:install

=== Edit configuration files

Edit the generated config files to your taste.
Most importantly, identify the container that should be refreshed by Ajax calls, and set it in <em>config/initializers/rails-ajax-config.rb</em>:

 main_container 'div#Content'

=== Include Javascript files

Include rails-ajax Javascript files in your asset pipeline (<em>app/assets/javascripts/application.js</em>):

<tt>// RailsAjax</tt>

<tt>//= require jquery.history</tt>

<tt>//= require jquery.rails-ajax</tt>

<tt>//= require RailsAjax-Config</tt>

=== It already works

Just restart your Rails server and your application should be working using Ajax calls to refresh just your main site container, with history, redirects, forms... working exactly the same way they did before.

For more advanced features, see {its home page}[http://rails-ajax.x-aeon.com].

== Who contributed to it ?

Check the AUTHORS[http://github.com/Muriel-Salvan/rails-ajax/blob/master/AUTHORS.rdoc] file.

== What is the license ?

BSD - You can find in the LICENSE[http://github.com/Muriel-Salvan/rails-ajax/blob/master/LICENSE] file.