diff --git a/README.md b/README.md index df72fd6..bc744ba 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,13 @@ [Passport](https://github.com/jaredhanson/passport) strategy for authenticating with [Yahoo!](http://www.yahoo.com/) using OpenID 2.0. -## Installation +This module lets you authenticate using Yahoo! in your Node.js applications. +By plugging into Passport, Yahoo! authentication can be easily and +unobtrusively integrated into any application or framework that supports +[Connect](http://www.senchalabs.org/connect/)-style middleware, including +[Express](http://expressjs.com/). + +## Install $ npm install passport-yahoo @@ -36,11 +42,7 @@ For example, as route middleware in an [Express](http://expressjs.com/) application: app.get('/auth/yahoo', - passport.authenticate('yahoo'), - function(req, res){ - // The request will be redirected to Yahoo for authentication, so - // this function will not be called. - }); + passport.authenticate('yahoo')); app.get('/auth/yahoo/return', passport.authenticate('yahoo', { failureRedirect: '/login' }), @@ -66,23 +68,6 @@ For a complete, working example, refer to the [signon example](https://github.co ## License -(The MIT License) - -Copyright (c) 2011 Jared Hanson - -Permission is hereby granted, free of charge, to any person obtaining a copy of -this software and associated documentation files (the "Software"), to deal in -the Software without restriction, including without limitation the rights to -use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of -the Software, and to permit persons to whom the Software is furnished to do so, -subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. +[The MIT License](http://opensource.org/licenses/MIT) -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS -FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR -COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER -IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN -CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +Copyright (c) 2011-2013 Jared Hanson <[http://jaredhanson.net/](http://jaredhanson.net/)>