Skip to content

Commit

Permalink
updated README.md
Browse files Browse the repository at this point in the history
Added some information around installation and requiring specific strategies.  Not knowing this caused me a day of poking around trying to figure out why my project wasn't working.  :(
  • Loading branch information
rnhurt committed Apr 10, 2014
1 parent b411e8c commit 6a6602f
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,19 @@ http://broadcast.oreilly.com/2009/12/principles-for-standardized-rest-authentica

The gem also provides a small helper class that can be used to generate request signatures.

## Installation

Install the gem:

gem install warden-hmac-authentication

Or use Bundler:

gem 'warden-hmac-authentication', require: ['hmac/strategies/header','hmac/strategies/query']

_NOTE: This gem is designed to allow partial loading - no code will be auto-loaded by defaut. That's why you have
to specify each individual strategy you want to load._

## Header-Based authentication

The header-based authentication transports the authentication information in the (misnamed) `Authorization` HTTP-Header. The primary
Expand Down

0 comments on commit 6a6602f

Please sign in to comment.