README.md in cone-0.0.2 vs README.md in cone-0.0.3

- old
+ new

@@ -1,30 +1,30 @@ # cone -Automatically generated javascript url helpers based on your Rails routes. +Automatically generated Javascript URL helpers based on your Rails routes. -## usage +## Usage ``` user GET /users/:id(.:format) users#show ``` -Let's say you have this Rails route. Here's how you would access it in javascript with cone: +Let's say you have this Rails route. Here's how you would access it in Javascript with cone: ```javascript -cone.userUrl({id: 12 }); +cone.userPath({id: 12}); "/users/12" -cone.userUrl({id: 12, format: 'json' }); +cone.userPath({id: 12, format: 'json'}); "/users/12.json" -cone.userUrl({id: 12, format: 'json', foo: 'bar baz'}); +cone.userPath({id: 12, format: 'json', foo: 'bar baz'}); "/users/12.json?foo=bar%20baz" ``` -Reload the server whenever your routes change to have the javascript regenerated. +Reload the server whenever your routes change to have the Javascript regenerated. -## installation +## Installation 1. Add gem 'cone' to your Gemfile. 2. Run bundle install. 3. Add //= require cone to your Javascript manifest file (usually found at app/assets/javascripts/application.js). -4. Restart your server +4. Restart your server. \ No newline at end of file