README & LICENSE

LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Stephan Maka
+
+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 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.
+

README.md

@@ -0,0 +1,40 @@
+# WebSockets From Space*
+
+*\** There are no users in space, only astronauts with the latest browser. Therefore no graceful fallback is attempted.
+
+## API
+
+### Setup
+
+    var server = http.createServer(...);
+    server.listen(port);
+
+    require('spacesocket').attach(server, function(conn) {
+        dealWithWebSocket(conn);
+    });
+
+### Reading
+
+    conn.on('data', function(msg) {
+        doStuffWithString(msg);
+    });
+
+### Writing
+
+    conn.send('Hello, World')
+
+### Closure
+
+    conn.end();
+
+### Buffer control
+
+    conn.on('drain', function() {
+        // socket write queue is empty,
+        // send until queueing again:
+        while(conn.send(data)) { }
+    });
+
+    // Throttle sender for 1s:
+    conn.pause();
+    setTimeout(function() { conn.resume(); }, 1000);