README.rdoc in github_api-0.3.3 vs README.rdoc in github_api-0.3.4

- old
+ new

@@ -1,7 +1,9 @@ -= github {<img src="http://travis-ci.org/peter-murach/github.png?branch=master" />}[http://travis-ci.org/peter-murach/github] += GithubAPI {<img src="http://travis-ci.org/peter-murach/github.png?branch=master" />}[http://travis-ci.org/peter-murach/github] {<img src="https://gemnasium.com/peter-murach/github.png?travis" />}[https://gemnasium.com/peter-murach/github] +Wiki[https://github.com/peter-murach/github/wiki] | RDocs[http://rubydoc.info/github/peter-murach/github/master/frames] + A Ruby wrapper for the GitHub REST API v3. Supports all the API methods(nearly 200). It's build in a modular way, that is, you can either instantiate the whole api wrapper Github.new or use parts of it e.i. Github::Repos.new if working solely with repositories is your main concern. == Installation @@ -10,18 +12,18 @@ gem install github_api or in your Gemfile - gem "github_api", "~> 0.3.2" + gem "github_api" == Usage Create a new client instance @github = Github.new -At this stage you can also supply various configuration parameters, such as :user, :repo, :org, :oauth_token, :login, :password or :basic_auth which are used thoughtout the API +At this stage you can also supply various configuration parameters, such as :user, :repo, :org, :oauth_token, :login, :password or :basic_auth which are used throughout the API @github = Github.new :user => 'peter-murach', :repo => 'github-api' You can authenticate either using OAuth authentication convenience methods(see section OAuth) or through basic authentication by passing your login and password credentials