Tree [edb2a1] master /
History



File Date Author Commit
Distribution 2014-04-15 Muriel Salvan Muriel Salvan [a78cb7] Code review: used Hash 1.9 syntax where appropr...
assets 2014-03-19 Muriel Salvan Muriel Salvan [d0c50c] Complete code review
examples 2014-04-15 Muriel Salvan Muriel Salvan [5f3e77] Code review: Rubocop is much happier now
gen 2014-04-15 Muriel Salvan Muriel Salvan [a78cb7] Code review: used Hash 1.9 syntax where appropr...
lib 2014-07-25 Muriel Salvan Muriel Salvan [5f6382] Disabled caching for JSON response to avoid bro...
tasks 2014-03-19 Muriel Salvan Muriel Salvan [d0c50c] Complete code review
test 2014-07-25 Muriel Salvan Muriel Salvan [5f6382] Disabled caching for JSON response to avoid bro...
.gitignore 2013-07-31 Muriel Salvan Muriel Salvan [bf3779] Integrate same test cases running for both Rail...
.hound.yml 2014-04-10 Muriel Salvan Muriel Salvan [3bac14] Integrated Hound
.metrics 2014-04-18 Muriel Salvan Muriel Salvan [5313f8] Dummy commit to test push
.travis.yml 2014-04-11 Muriel Salvan Muriel Salvan [efb6e9] Do not activate rails-ajax when onclick events ...
AUTHORS.rdoc 2014-03-20 Muriel Salvan Muriel Salvan [4596ad] Released v1.0.0.20140320
ChangeLog 2014-03-20 Muriel Salvan Muriel Salvan [4596ad] Released v1.0.0.20140320
Credits 2012-07-06 Muriel Salvan Muriel Salvan [ef0eec] Initial commit
Gemfile 2014-04-18 Muriel Salvan Muriel Salvan [cec8fb] Minor commit to test push
LICENSE 2014-03-20 Muriel Salvan Muriel Salvan [e9a99e] Updated license and removed useless copyright n...
README.rdoc 2014-04-14 Muriel Salvan Muriel Salvan [693dc0] Updated README
Rakefile 2013-03-19 Muriel Salvan Muriel Salvan [f6838b] added temporization after history.back for webk...
rails-ajax.gemspec 2013-07-05 Muriel Salvan Muriel Salvan [40e2bb] Migrated to last gems versions
reek.yml 2014-04-18 Muriel Salvan Muriel Salvan [a71417] Added metric_fu support

Read Me

{<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.