github-migration/sisyphus-rails
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
Fixed up readme a bit
This commit is contained in:
dnoonan 2012-10-01 17:55:36 -03:00
parent 29e035b8fd
commit 810a02bece
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -16,15 +16,19 @@ Or install it yourself as:
$ gem install sisyphus-rails
For a basic install include the following in your ++app/assets/javascripts/application.js++ file
For a basic install include the following in your *app/assets/javascripts/application.js* file
//= require jstorage
//= require sisyphus
## How it Works
Sisyphus uses an aliased form_tag method to automatically put a ++<script>...</script>++ tag infront of your forms.
Sisyphus uses an aliased form_tag method to automatically put a *&lt;script&gt;...&lt;/script&gt;* tag infront of your forms to initialize Sisyphus
<script>$(document).ready(function() {$('#sampleform').sisyphus();});</script>
<form id="sampleform">
...
</form>
## Usage
Sisyphus automatically works with all your forms, including custom form builders.