Updated README and gemspec
This commit is contained in:
parent
f0d13cd224
commit
b9e0c8da1b
15
README.md
15
README.md
@ -16,15 +16,28 @@ Or install it yourself as:
|
|||||||
|
|
||||||
$ gem install sisyphus-rails
|
$ gem install sisyphus-rails
|
||||||
|
|
||||||
|
For a basic install include the following in your ++app/assets/javascripts/application.js++ file
|
||||||
|
|
||||||
|
//= require jstorage
|
||||||
|
//= require sisyphus
|
||||||
|
|
||||||
## Usage
|
## 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
|
## TODO
|
||||||
|
|
||||||
- Tests
|
- Tests
|
||||||
- Multiple library support for jStorage (Prototype, Mootools etc.)
|
- Multiple library support for jStorage (Prototype, Mootools etc.)
|
||||||
- Support for formtastic and extending other form builders
|
- Support for formtastic and extending other form builders
|
||||||
|
- Model/Object based exclusions
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
# -*- encoding: utf-8 -*-
|
# -*- encoding: utf-8 -*-
|
||||||
lib = File.expand_path('../lib', __FILE__)
|
lib = File.expand_path('../lib', __FILE__)
|
||||||
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
||||||
require 'sisyphus-rails/version'
|
require 'sisyphus/rails/version'
|
||||||
|
|
||||||
Gem::Specification.new do |gem|
|
Gem::Specification.new do |gem|
|
||||||
gem.name = "sisyphus-rails"
|
gem.name = "sisyphus-rails"
|
||||||
|
Loading…
Reference in New Issue
Block a user