Switch up Markdown syntax for headers [ci skip]

This commit is contained in:
Erik Michaels-Ober 2011-08-19 14:12:39 -07:00
parent 753eb5fc63
commit c6e8f8af0c
1 changed files with 10 additions and 30 deletions

View File

@ -1,5 +1,4 @@
OmniAuth: Standardized Multi-Provider Authentication
====================================================
# OmniAuth: Standardized Multi-Provider Authentication
OmniAuth is a new Rack-based authentication system for multi-provider external
authentcation. OmniAuth is built from the ground up on the philosophy that
**authentication is not the same as identity**, and is based on two
@ -13,18 +12,15 @@ observations:
to one, three, or twelve other services. Modern authentication systems
should allow a user's identity to be associated with many authentications.
<a name="installation">Installation</a>
------------
## <a name="installation">Installation</a>
To install OmniAuth, simply install the gem:
gem install omniauth
<a name="ci">Continuous Integration</a>
----------------------
## <a name="ci">Continuous Integration</a>
[![Build Status](https://secure.travis-ci.org/intridea/omniauth.png)](http://travis-ci.org/intridea/omniauth)
Providers
---------
## <a name="providers">Providers</a>
OmniAuth currently supports the following external providers:
* via OAuth (OAuth 1.0, OAuth 2, and xAuth)
@ -89,19 +85,7 @@ OmniAuth currently supports the following external providers:
* OpenID (credit: [mbleigh](https://github.com/mbleigh))
* Yupoo (credit: [chouti](https://github.com/chouti))
Compatibility
-------------
OmniAuth is tested against the following Ruby versions:
* 1.8.7
* 1.9.1
* 1.9.2
* JRuby (note, the Evernote strategy is not available for JRuby)
* Rubinius
* REE
<a name="usage">Usage</a>
-----
## <a name="usage">Usage</a>
OmniAuth is a collection of Rack middleware. To use a single strategy, you simply need to add the middleware:
require 'oa-oauth'
@ -127,8 +111,7 @@ The hash in question will look something like this:
The `user_info` hash will automatically be populated with as much information about the user as OmniAuth was able to pull from the given API or authentication provider.
Resources
---------
## <a name="resources">Resources</a>
The best place to find more information is the [OmniAuth Wiki](https://github.com/intridea/omniauth/wiki). Some specific information you might be interested in:
* [CI Build Status](http://travis-ci.org/intridea/omniauth)
@ -137,13 +120,11 @@ The best place to find more information is the [OmniAuth Wiki](https://github.co
* [Report Issues](https://github.com/intridea/omniauth/issues)
* [Mailing List](http://groups.google.com/group/omniauth)
OmniAuth Core
-------------
## <a name="core">Core Team</a>
* **Michael Bleigh** ([mbleigh](https://github.com/mbleigh))
* **Erik Michaels-Ober** ([sferik](https://github.com/sferik))
<a name="rubies">Supported Rubies</a>
----------------
## <a name="rubies">Supported Rubies</a>
This library aims to support and is [tested
against](http://travis-ci.org/intridea/omniauth) the following Ruby
implementations:
@ -168,6 +149,5 @@ implementation, you will be personally responsible for providing patches in a
timely fashion. If critical issues for a particular implementation exist at the
time of a major release, support for that Ruby version may be dropped.
License
-------
OmniAuth is licensed under the MIT License.
## <a name="license">License</a>
OmniAuth is released under the MIT License.