Add README.md

.gitignore

@@ -1,9 +1,9 @@
-###Node###
-
+########################
+# node.js / npm
+########################
 lib-cov
 *.seed
 *.log
-*.csv
 *.dat
 *.out
 *.pid
@@ -13,5 +13,26 @@ pids
 logs
 results
 
+node_modules
+
 npm-debug.log
-node_modules
+
+
+########################
+# misc / editors
+########################
+*~
+*#
+.DS_STORE
+.netbeans
+nbproject
+.idea
+
+
+########################
+# Test
+########################
+coverage.html
+
+
+

README.md

@@ -0,0 +1,76 @@
+# passport-cas
+
+Cas authentication strategies for Passport.
+
+
+## Install
+
+    $ npm install passport-cas
+
+#### Configure Strategy
+
+    passport.use(new (require('passport-cas').Strategy)({
+      ssoBaseURL: 'http://www.example.com/',
+      serverBaseURL: 'http://localhost:3000'
+    }, function(login, done) {
+      User.findOne({login: login}, function (err, user) {
+        if (err) {
+          return done(err);
+        }
+        if (!user) {
+          return done(null, false, {message: 'Unknown user'});
+        }
+        return done(null, user);
+      });
+    }));
+
+#### Authenticate Requests
+
+    passport.authenticate('cas', function (err, user, info) {
+      if (err) {
+        return next(err);
+      }
+
+      if (!user) {
+        req.session.messages = info.message;
+        return res.redirect('/');
+      }
+
+      req.logIn(user, function (err) {
+        if (err) {
+          return next(err);
+        }
+
+        req.session.messages = '';
+        return res.redirect('/');
+      });
+    })
+
+For example:
+
+    // GET: '/cas_login'
+    exports.casLogin = function(req, res, next) {
+      passport.authenticate('cas', function (err, user, info) {
+        if (err) {
+          return next(err);
+        }
+
+        if (!user) {
+          req.session.messages = info.message;
+          return res.redirect('/');
+        }
+
+        req.logIn(user, function (err) {
+          if (err) {
+            return next(err);
+          }
+
+          req.session.messages = '';
+          return res.redirect('/');
+        });
+      })(req, res, next);
+    };
+
+## License
+
+[The MIT License](http://opensource.org/licenses/MIT)