diff --git a/README.md b/README.md index 26fede4..9f80478 100644 --- a/README.md +++ b/README.md @@ -16,15 +16,28 @@ Or install it yourself as: $ gem install sisyphus-rails +For a basic install include the following in your ++app/assets/javascripts/application.js++ file + + //= require jstorage + //= require sisyphus + ## Usage -Requires jquery. +If you are using the default form builder you do not have to modify anything to have Sisyphus start auto-saving your forms. + +ActionView::Base.default_form_builder = YourFormBuilder + +## Dependencies + +- Rails >= 3.1 +- Jquery ## TODO - Tests - Multiple library support for jStorage (Prototype, Mootools etc.) - Support for formtastic and extending other form builders +- Model/Object based exclusions ## Contributing diff --git a/sisyphus-rails.gemspec b/sisyphus-rails.gemspec index a40d7da..60145c2 100644 --- a/sisyphus-rails.gemspec +++ b/sisyphus-rails.gemspec @@ -1,7 +1,7 @@ # -*- encoding: utf-8 -*- lib = File.expand_path('../lib', __FILE__) $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) -require 'sisyphus-rails/version' +require 'sisyphus/rails/version' Gem::Specification.new do |gem| gem.name = "sisyphus-rails"