README.rdoc in djr-0.0.2 vs README.rdoc in djr-0.0.3

- old
+ new

@@ -1,7 +1,36 @@ = djr -Description goes here. +DJR will generate the JavaScript code from Rails Controllers to allow browsers to securely call into Ruby code almost as if it was running locally + +## Getting started + +Add it to your Gemfile with: + gem 'djr' + +Run the bundle command to install it. + +Configure assets in app/assets/application.js file: + +//= require jquery +//= require djr +//= require_tree . + +Import script in your pages: + + <script type="text/javascript" charset="utf-8" src="/djr"></script> + +In javascript, call your Controller like: + +productsController = new ProductsController +productsController.save({ + name: "IPhone 4s", + value: "500.00" +}, callbackFunction); + +## Conventions + +controller.action( dataAsJson, callbackFunction, errorHandler ); == Contributing to djr * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet. * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.