Skip to content
This repository has been archived by the owner on Nov 10, 2017. It is now read-only.

Commit

Permalink
Change outdated 'github_request' API instructions for calling authent…
Browse files Browse the repository at this point in the history
…icated Octokit::Client.

Just updating the README to reflect current reality.

I banged my head against using github_request with errors after using the 'sinatra-auth-github-test' repository as a basis and trying to duplicate the code outside of it using the sinatra_auth_github gem from scratch. It took a while to realize that there was a possible version mismatch between projects.
  • Loading branch information
blueminder committed Aug 21, 2013
1 parent e956058 commit 98d1b60
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,17 +36,17 @@ You can check team membership by hitting http://localhost:9393/teams/42

All unsuccessful authentication requests get sent to the securocat denied page.

API Requests
API Access
============

The extension also provides a simple way to do get requests against the
GitHub API as the authenticated user.
The extension also provides a simple way to access the GitHub API, by providing an
authenticated Octokit::Client for the user.

def repos
github_request("user/repos")
github_user.api.repositories
end

There's awesome docs on the v3 API [available here](http://developer.github.com/v3/).
For more information on API access, refer to the [octokit documentation](http://rdoc.info/gems/octokit).

Extension Options
=================
Expand Down

0 comments on commit 98d1b60

Please sign in to comment.