Skip to content

Commit

Permalink
Upgrading guide for v3
Browse files Browse the repository at this point in the history
Fixes #459
  • Loading branch information
pengwynn committed Aug 19, 2014
1 parent 0512982 commit ab5f994
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -360,6 +360,27 @@ construction currently used throughout the client.

## Upgrading guide

Version 3.0 includes a couple breaking changes when upgrading from v2.x.x:

The [default media type][default-media-type] is now `v3` instead of `beta`. If
you need to request the older media type, you can set the default media type
for the client:

```ruby
Octokit.default_media_type = "application/vnd.github.beta+json"
```
or per-request

```ruby
Octokit.emails(:accept => "application/vnd.github.beta+json")
```

The long-deprecated `Octokit::Client#create_download` method has been removed.

[default-media-type]: https://developer.github.com/changes/2014-01-07-upcoming-change-to-default-media-type/

### Upgrading from 1.x.x

Version 2.0 includes a completely rewritten `Client` factory that now memoizes
client instances based on unique configuration options. Breaking changes also
include:
Expand Down

0 comments on commit ab5f994

Please sign in to comment.