Skip to content

Commit 00a222e

Browse files
committed
Update README.
1 parent da5dcde commit 00a222e

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,22 @@
22

33
HTTP OAuth authentication strategy for [Passport](https://github.com/jaredhanson/passport).
44

5+
This module lets you authenticate HTTP requests using the authorization scheme
6+
defined by the [OAuth](http://tools.ietf.org/html/rfc5849) 1.0 protocol. OAuth
7+
is typically used protect API endpoints, including endpoints defined by the
8+
OAuth protocol itself, as well as other endpoints exposed by the server.
9+
10+
By plugging into Passport, OAuth API authentication can be easily and
11+
unobtrusively integrated into any application or framework that supports [Connect](http://www.senchalabs.org/connect/)-style
12+
middleware, including [Express](http://expressjs.com/).
13+
14+
Note that this strategy provides support for implementing OAuth as a service
15+
provider. If your application is implementing OAuth as a client for delegated
16+
authentication (for example, using [Facebook](https://github.com/jaredhanson/passport-facebook)
17+
or [Twitter](https://github.com/jaredhanson/passport-twitter)), please see
18+
[Passport-OAuth](https://github.com/jaredhanson/passport-oauth) for the
19+
appropriate strategy.
20+
521
## Examples
622

723
The [example](https://github.com/jaredhanson/oauthorize/tree/master/examples/express2)

0 commit comments

Comments
 (0)