Permalink
Browse files

Initial README (I will get a better one!)

  • Loading branch information...
eee-c committed Jun 22, 2011
1 parent a0d8e94 commit 6e504eeb6a07e670e9050b8bf13bd3bebc03e0c1
Showing with 55 additions and 0 deletions.
  1. +55 −0 README.md
View
@@ -0,0 +1,55 @@
+express-spdy
+============
+
+*WARNING: this is very, very alpha stuff.*
+
+[SPDY](http://www.chromium.org/spdy) is a new protocol from Google based on HTTP. It aims for 50% decrease in page load times over vanilla HTTP.
+
+Currently Google Chrome is the only browser that supports SPDY.
+
+The express-spdy package aims to allow existing express.js sites to experiment with SPDY without making (many) changes.
+
+
+INSTALLATION
+------------
+
+Install the latest snapshot of openssl with NPN and shared objects. Currently (6/21/2011), this requires obtaining a SNAP tarball from the openssl FTP server or checking out the latest trunk from the openssl CVS server.
+
+Install node.js 0.5.0-pre or later. Currently (6/21/2011), this requires installing node from the master repository (0.4.8 will _not_ work).
+
+_More instructions_ on installing the latest openssl + node are available at: http://japhr.blogspot.com/2011/06/setting-up-node-spdy.html
+
+With the npn-enabled node, `npm install express-spdy`.
+
+CONFIGURATION
+-------------
+
+An express.js app can then be SPDY-ized by changing the first few lines to:
+
+ var express = require('express-spdy')
+ , fs = require('fs');
+
+ var app = module.exports = express.createServer({
+ key: fs.readFileSync(__dirname + '/keys/spdy-key.pem'),
+ cert: fs.readFileSync(__dirname + '/keys/spdy-cert.pem'),
+ ca: fs.readFileSync(__dirname + '/keys/spdy-csr.pem'),
+ NPNProtocols: ['spdy/2']
+ });
+
+Better instructions to follow....
+
+
+TODO
+----
+
+* Tests
+* Verify that this works with more than a single request
+* Verify that other browsers are still able to access
+* Server push
+* Documentation (of course)
+
+
+THANKS
+------
+
+_Huge_ thanks to [Fedor Indutny](https://github.com/indutny) for his awesome [node-spdy](https://github.com/indutny/node-spdy). Very little was required to get express-spdy working thanks to his hard work.

0 comments on commit 6e504ee

Please sign in to comment.