Skip to content

Commit

Permalink
Added descriptions to oauth module's configurables.
Browse files Browse the repository at this point in the history
  • Loading branch information
bnoguchi committed Apr 6, 2011
1 parent ecb2d9f commit 71733e7
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion lib/oauth.js
Expand Up @@ -12,7 +12,13 @@ everyModule.submodule('oauth')
.definit( function () {
this.oauth = new OAuth(this.appId(), this.appSecret(), this.apiHost());
})
.configurable('apiHost appId appSecret myHostname redirectPath')
.configurable({
apiHost: 'e.g., https://graph.facebook.com'
, appId: 'the OAuth app id provided by the host'
, appSecret: 'the OAuth secret provided by the host'
, myHostname: 'e.g., http://local.host:3000 . Notice no trailing slash'
, redirectPath: 'Where to redirect to after a failed or successful OAuth authorization'
})
.get('entryPath') // Declares a GET route that is aliased
// as 'entryPath'. The handler for this route
// triggers the series of steps that you see
Expand Down

0 comments on commit 71733e7

Please sign in to comment.