Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Merge pull request #30 from rnhurt/master

updated README.md
  • Loading branch information...
commit 10005a8d205411405e7f5f5d5711c3c2228b5b71 2 parents b411e8c + 6a6602f
@Xylakant Xylakant authored
Showing with 13 additions and 0 deletions.
  1. +13 −0 README.md
View
13 README.md
@@ -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
Please sign in to comment.
Something went wrong with that request. Please try again.