README.md in sinatra_auth_github-0.13.3 vs README.md in sinatra_auth_github-0.14.0
- old
+ new
@@ -26,15 +26,15 @@
There's an example app in [spec/app.rb](/spec/app.rb).
Example App Functionality
=========================
-You can simply authenticate via GitHub by hitting http://localhost:9292
+You can simply authenticate via GitHub by hitting http://localhost:9393
-You can check organization membership by hitting http://localhost:9292/orgs/github
+You can check organization membership by hitting http://localhost:9393/orgs/github
-You can check team membership by hitting http://localhost:9292/teams/42
+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
============
@@ -54,6 +54,13 @@
* `:scopes` - The OAuth2 scopes you require, [Learn More](http://gist.github.com/419219)
* `:secret` - The client secret that GitHub provides
* `:client_id` - The client id that GitHub provides
* `:failure_app` - A Sinatra::Base class that has a route for `/unauthenticated`, Useful for overriding the securocat default page.
* `:callback_url` - The path that GitHub posts back to, defaults to `/auth/github/callback`.
-* `:oauth_domain` - The scheme and host that's GitHub's endpoint, defaults to `https://github.com`
+
+Enterprise Authentication
+=========================
+
+Under the hood, the `warden-github` portion is powered by octokit. If you find yourself wanting to connect to a GitHub Enterprise installation you'll need to export two environmental variables.
+
+* OCTOKIT_WEB_ENDPOINT - The web endpoint for OAuth, defaults to https://github.com
+* OCTOKIT_API_ENDPOINT - The API endpoint for authenticated requests, defaults to https://api.github.com