aboutsummaryrefslogtreecommitdiff
path: root/node_modules/passport-strategy/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/passport-strategy/README.md')
-rw-r--r--node_modules/passport-strategy/README.md61
1 files changed, 61 insertions, 0 deletions
diff --git a/node_modules/passport-strategy/README.md b/node_modules/passport-strategy/README.md
new file mode 100644
index 0000000..71de07f
--- /dev/null
+++ b/node_modules/passport-strategy/README.md
@@ -0,0 +1,61 @@
+# passport-strategy
+
+[![Build](https://travis-ci.org/jaredhanson/passport-strategy.png)](http://travis-ci.org/jaredhanson/passport-strategy)
+[![Coverage](https://coveralls.io/repos/jaredhanson/passport-strategy/badge.png)](https://coveralls.io/r/jaredhanson/passport-strategy)
+[![Dependencies](https://david-dm.org/jaredhanson/passport-strategy.png)](http://david-dm.org/jaredhanson/passport-strategy)
+
+
+An abstract class implementing [Passport](http://passportjs.org/)'s strategy
+API.
+
+## Install
+
+ $ npm install passport-strategy
+
+## Usage
+
+This module exports an abstract `Strategy` class that is intended to be
+subclassed when implementing concrete authentication strategies. Once
+implemented, such strategies can be used by applications that utilize Passport
+middleware for authentication.
+
+#### Subclass Strategy
+
+Create a new `CustomStrategy` constructor which inherits from `Strategy`:
+
+```javascript
+var util = require('util')
+ , Strategy = require('passport-strategy');
+
+function CustomStrategy(...) {
+ Strategy.call(this);
+}
+
+util.inherits(CustomStrategy, Strategy);
+```
+
+#### Implement Authentication
+
+Implement `autheticate()`, performing the necessary operations required by the
+authentication scheme or protocol being implemented.
+
+```javascript
+CustomStrategy.prototype.authenticate = function(req, options) {
+ // TODO: authenticate request
+}
+```
+
+## Tests
+
+ $ npm install
+ $ npm test
+
+## Credits
+
+ - [Jared Hanson](http://github.com/jaredhanson)
+
+## License
+
+[The MIT License](http://opensource.org/licenses/MIT)
+
+Copyright (c) 2011-2013 Jared Hanson <[http://jaredhanson.net/](http://jaredhanson.net/)>