Skip to content

Commit

Permalink
document p.upgrade(), travis badge
Browse files Browse the repository at this point in the history
  • Loading branch information
James Halliday committed Feb 13, 2012
1 parent 086a62c commit 40c73e4
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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
=======

Expand Down Expand Up @@ -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
======

Expand Down

0 comments on commit 40c73e4

Please sign in to comment.