Skip to content

Commit

Permalink
Add documentation about optional options
Browse files Browse the repository at this point in the history
  • Loading branch information
jbuck committed Sep 24, 2012
1 parent d9945e8 commit f0c00ae
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,18 @@ Documentation
* `audience` - The URL of your express app when viewed in a browser. Must include the protocol, hostname, and port.
* Example: `http://example.org:80`, `https://example.org:443`

### Optional options:

* `verifyPath` - The URL that clients use to verify credentials.
* Default: `/persona/verify`
* Examples: `/browserid/verify`, `/api/verify`
* `logoutPath` - The URL that clients use to logout.
* Default: `/persona/logout`
* Examples: `/browserid/logout`, `/api/logout`
* `sessionKey` - The session key to store the validated email in.
* Default: `email`
* Example: `user`, `username`

Tests
-----
Run tests using `npm test`.

0 comments on commit f0c00ae

Please sign in to comment.