README.md in platform-api-0.1.0 vs README.md in platform-api-0.2.0

- old
+ new

@@ -260,25 +260,10 @@ ``` Hopefully this has given you a taste of how the client works. If you have questions please feel free to file issues. -### Building API documentation - -Build documentation with: - -``` -rake yard -``` - -And then visit `docs/index.html` to read it. Alternaltely, build and publish -it to Github Pages in one step with: - -``` -rake publish -``` - ### Debugging Sometimes it helps to see more information about the requests flying by. You can start your program or an `irb` session with the `EXCON_DEBUG=1` environment variable to cause request and response data to be written to @@ -303,17 +288,52 @@ client = PlatformAPI.connect('my-api-key', cache: Moneta.new(:Memory)) ``` ### Connecting to a different host -Connect to a different host by passing a host option: +Connect to a different host by passing a `url` option: ```ruby -client = PlatformAPI.connect('my-api-key', host: 'api.example.com') +client = PlatformAPI.connect('my-api-key', url: 'https://api.example.com') ``` -Connections are always made using HTTPS and certificates verification is -always enabled. +## Building and releasing + +### Generate a new client + +Generate a new client from the Heroku Platform API JSON schema: + +``` +rake build +``` + +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 +``` + +### Building API documentation + +Build documentation with: + +``` +rake yard +``` + +And then visit `docs/index.html` to read it. Alternaltely, build and publish +it to Github Pages in one step with: + +``` +rake publish +``` + +You can see it live on [Github Pages](http://heroku.github.io/platform-api/). ## Contributing 1. [Fork the repository](https://github.com/heroku/platform-api/fork). 2. Create your feature branch: `git checkout -b my-new-feature`