README.md in platform-api-0.7.0 vs README.md in platform-api-0.8.0

- old
+ new

@@ -22,11 +22,11 @@ gem install platform-api ``` ## API documentation -Jump right to the [API documentation](http://heroku.github.io/platform-api/) +Jump right to the [API documentation](http://heroku.github.io/platform-api/_index.html) for the nitty gritty details. ## Usage guide The best place to start using the Heroku API is the [Platform API Reference](https://devcenter.heroku.com/articles/platform-api-reference). @@ -47,17 +47,17 @@ For example, to get information about the `web` formation on the `sushi` app you'd invoke `heroku.formation.info('sushi', 'web')` and it would return a Ruby object that matches the one given in the [response example](https://devcenter.heroku.com/articles/platform-api-reference#formation-info). -The [API documentation] contains a description of all available resources and -methods. +The [API documentation](http://heroku.github.io/platform-api/_index.html) contains a +description of all available resources and methods. ### Handling errors The client uses [Excon](https://github.com/geemus/excon) under the hood and -raises `Excon::Error` exceptions when errors occur. You can catch specific +raises `Excon::Errors::Error` exceptions when errors occur. You can catch specific [Excon error types](https://github.com/geemus/excon/blob/master/lib/excon/errors.rb) if you want. ### A real world example Let's go through an example of creating an app and using the API to work with @@ -85,11 +85,11 @@ create tokens with specific scopes. Now let's create an app: ```ruby -heroku.app.create +heroku.app.create({}) => {"id"=>22979756, "name"=>"floating-retreat-4255", "dynos"=>0, "workers"=>0, "repo_size"=>nil, @@ -308,15 +308,13 @@ Remember to commit and push the changes to Github. ### Release a new gem -Bump the version in `lib/platform-api/version.rb` and push a new release to -Rubygems: - -``` -rake release -``` +* Bump the version in `lib/platform-api/version.rb` +* `bundle install` to update Gemfile.lock +* `git commit -m 'vX.Y.Z' to stage the version and Gemfile.lock changes +* `rake release` to push git changes and to release to Rubygems ### Building API documentation Build documentation with: