README.md in octokit-1.19.0 vs README.md in octokit-1.20.0
- old
+ new
@@ -59,17 +59,34 @@
```ruby
client = Octokit::Client.new(:login => "me", :password => "sekret")
client.follow("sferik")
```
-Alternately, you can authenticate with a [GitHub OAuth2 token][oauth].
+Alternately, you can authenticate with a [GitHub OAuth2 token][oauth].
```ruby
client = Octokit::Client.new(:login => "me", :oauth_token => "oauth2token")
client.follow("sferik")
```
+### Using `.netrc` for stored credentials
+
+Octokit now supports [`.netrc`][netrc] files for storing your GitHub Basic Auth
+credentials. Given a `~/.netrc` like the following
+
+```
+machine api.github.com login pengwynn password 0ct0c4tz4ev3r!
+```
+
+You can make authenticated calls by telling Octokit to use credentials from
+this file:
+
+```ruby
+Octokit.netrc => true # or /path/to/file
+Octokit.user # authenticates as 'pengwynn' user
+```
+
## Requesting a specific media type
You can pass an `:accept` option value to request a particular [media
type][media-types].
@@ -128,10 +145,26 @@
run and pass on that implementation. When something breaks on your
implementation, you will be personally responsible for providing patches in a
timely fashion. If critical issues for a particular implementation exist at the
time of a major release, support for that Ruby version may be dropped.
+## Versioning
+
+This library aims to adhere to [Semantic Versioning 2.0.0][semver]. Violations
+of this scheme should be reported as bugs. Specifically, if a minor or patch
+version is released that breaks backward compatibility, that version should be
+immediately yanked and/or a new version should be immediately released that
+restores compatibility. Breaking changes to the public API will only be
+introduced with new major versions. As a result of this policy, you can (and
+should) specify a dependency on this gem using the [Pessimistic Version
+Constraint][pvc] with two digits of precision. For example:
+
+ spec.add_dependency 'octokit', '~> 1.0'
+
+[semver]: http://semver.org/
+[pvc]: http://docs.rubygems.org/read/chapter/16#page74
+
### JSON dependency
Since JSON is included in 1.9 now, we no longer include it as a hard
dependency. Please require it explicitly if you're running Ruby 1.8
@@ -160,5 +193,6 @@
[LICENSE][] for details.
[license]: https://github.com/pengwynn/octokit/blob/master/LICENSE.md
[media-types]: http://developer.github.com/v3/media/
[oauth]: http://developer.github.com/v3/oauth
+[netrc]: http://www.gnu.org/software/inetutils/manual/html_node/The-_002enetrc-File.html