Permalink
Browse files

documented the sugar and a bump to 0.0.1

  • Loading branch information...
1 parent 41cc13c commit fe380a50aa3b627834eceb8b7415c53a223875ef @substack committed Oct 10, 2011
Showing with 28 additions and 1 deletion.
  1. +27 −0 README.markdown
  2. +1 −1 package.json
View
@@ -24,6 +24,33 @@ bouncy(function (req, bounce) {
}).listen(8001);
````
+methods
+=======
+
+There is only one method, `bouncy(cb)`. Your callback `cb` will get these
+arguments:
+
+req
+---
+
+The node http module request object.
+
+bounce(stream)
+--------------
+
+Call this function when you're ready to bounce the request to a stream.
+
+The exact request that was received will be written to `stream` and future
+incoming data will be piped to and from it.
+
+bounce(port), bounce(host, port)
+--------------------------------
+
+These variants of `bounce()` are sugar for
+`bounce(net.createConnection(port))`
+and
+`bounce(net.createConnection(port, host))`.
+
install
=======
View
@@ -1,7 +1,7 @@
{
"name" : "bouncy",
"description" : "Bounce HTTP requests around for a load balancer or http host router completely transparently",
- "version" : "0.0.0",
+ "version" : "0.0.1",
"repository" : {
"type" : "git",
"url" : "git://github.com/substack/bouncy.git"

0 comments on commit fe380a5

Please sign in to comment.