Permalink
Browse files

document p.upgrade(), travis badge

  • Loading branch information...
1 parent 086a62c commit 40c73e425c46dc2dce6ce998ac86b743eb921371 @substack substack committed Feb 13, 2012
Showing with 10 additions and 2 deletions.
  1. +10 −2 README.markdown
View
@@ -6,6 +6,8 @@ HTTP parser written in node with hooks into the raw header and raw body.
You should only need this module if you're writing an HTTP proxy or something
similarly nefarious.
+[![build status](https://secure.travis-ci.org/substack/node-parsley.png)](http://travis-ci.org/substack/node-parsley)
+
example
=======
@@ -100,15 +102,21 @@ methods
var parsley = require('parsley')
-parsley(stream, cb)
--------------------
+var p = parsley(stream, cb)
+---------------------------
Parse `stream`, calling `cb` with a new `http.IncomingMessage`
object as soon as the first piece of data comes in.
If the connection is keep-alive, multiple requests may come through `cb` on the
same stream.
+p.upgrade()
+-----------
+
+Put the parser into upgrade mode manually. This is done automatically when the
+"upgrade" header is present or "connection: upgrade".
+
events
======

0 comments on commit 40c73e4

Please sign in to comment.