Skip to content

Commit

Permalink
READMEs and CHANGELOGs updated.
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael Bleigh committed May 1, 2010
1 parent da5cd70 commit 19d27d9
Show file tree
Hide file tree
Showing 7 changed files with 117 additions and 0 deletions.
3 changes: 3 additions & 0 deletions oa-basic/CHANGELOG.rdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
== 0.0.3

* First working release, Campfire and Basecamp support
34 changes: 34 additions & 0 deletions oa-basic/README.rdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
= OmniAuth::Basic

OmniAuth stratgies for APIs that have HTTP Basic authentication (such as Campfire and Basecamp).

== Installation

To get just HTTP Basic functionality:

gem install oa-basic

For the full auth suite:

gem install omniauth

== Stand-Alone Example

Use the strategy as a middleware in your application:

require 'omniauth/basic'

use OmniAuth::Strategies::Campfire

Then simply direct users to '/auth/campfire' to prompt them for their Campfire credentials. You may also pre-set the credentials by POSTing to the URL with appropriate parameters (in the case of Campfire and Basecamp, the parameters are <tt>subdomain</tt>, <tt>user</tt>, and <tt>password</tt>).

== OmniAuth Builder

If you want to allow multiple providers, use the OmniAuth Builder:

require 'omniauth/basic'

use OmniAuth::Builder do
provider :campfire
provider :basecamp
end
3 changes: 3 additions & 0 deletions oa-core/CHANGELOG.rdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
== 0.0.3

* Added OmniAuth::Form for displaying info forms on systems that will require them.
Empty file removed oa-core/README.rdoc
Empty file.
35 changes: 35 additions & 0 deletions oa-oauth/README.rdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
= OmniAuth::OAuth

OAuth 1.0 and 2.0 strategies for the OmniAuth gem.

== Installation

To get just OpenID functionality:

gem install oa-oauth

For the full auth suite:

gem install omniauth

== Stand-Alone Example

Use the strategy as a middleware in your application:

require 'omniauth/oauth'

use OmniAuth::Strategies::Twitter, 'consumer_key', 'consumer_secret'

Then simply direct users to '/auth/twitter' to have them authenticate via Twitter.

== OmniAuth Builder

If you want to allow multiple providers, use the OmniAuth Builder:

require 'omniauth/oauth'

use OmniAuth::Builder do
provider :twitter, 'consumer_key', 'consumer_secret'
provider :facebook, 'app_id', 'app_secret'
end

3 changes: 3 additions & 0 deletions oa-openid/CHANGELOG.rdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
== 0.0.3

* Display a form if no identifier is provided at /auth/open_id
39 changes: 39 additions & 0 deletions oa-openid/README.rdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
= OmniAuth::OpenID

OpenID strategies for the OmniAuth gem.

== Installation

To get just OpenID functionality:

gem install oa-openid

For the full auth suite:

gem install omniauth

== Stand-Alone Example

Use the strategy as a middleware in your application:

require 'omniauth/openid'
require 'openid/store/filesystem'

use OmniAuth::Strategies::OpenID, OpenID::Store::Filesystem.new('/tmp')

Then simply direct users to '/auth/open_id' to prompt them for their OpenID identifier. You may also pre-set the identifier by passing an <tt>identifier</tt> parameter to the URL (Example: <tt>/auth/open_id?identifier=google.com</tt>).

== OmniAuth Builder

If OpenID is one of several authentication strategies, use the OmniAuth Builder:

require 'omniauth-openid'
require 'omniauth-basic'
require 'openid/store/filesystem'

use OmniAuth::Builder do
provider :open_id, OpenID::Store::Filesystem.new('/tmp')
provider :campfire
end


0 comments on commit 19d27d9

Please sign in to comment.