initial

README.md

@@ -0,0 +1,50 @@
+Access [Passport.js](http://passportjs.org) user information from socket.io(http://socket.io) connection.
+
+
+Installation
+============
+
+```
+npm install passport.socketio
+```
+
+Usage 
+=====
+
+
+```javascript
+
+  //configure passport and express
+
+  var socketIo = require("socket.io"),
+    passportSocketIo = require("passport.socketio");
+
+  var sio = socketIo.listen(webServer);
+
+  sio.set("authorization", passportSocketIo.authorize({
+    sessionKey:    'express.sid',      //the cookie where express (or connect) stores its session id.
+    sessionStore:  mySessionStore,     //the session store that express uses
+    sessionSecret: "my session secret" //the session secret to parse the cookie
+  }));
+
+  sio.sockets.on("connection", function(socket){
+    console.log("user connected: ", socket.handshake.user.name);
+    
+    //filter sockets by user...
+    var userGender = socket.handshake.user.gender, 
+        opposite = userGender === "male" ? "female" : "male";
+
+    passportSocketIo.filterSocketsByUser(sio, function (user) {
+      return user.gender === opposite;
+    }).forEach(function(s){
+      s.send("a " + userGender + " has arrived!");
+    });
+
+  });
+
+```
+
+License
+========
+
+MIT - José F. Romaniello 2012.