Permalink
Browse files

[docs] add UPGRADING.md

  • Loading branch information...
yawnt committed Dec 20, 2013
1 parent 16828a9 commit db12f6c24e22c034c698457cc28ff60c990b55a5
Showing with 28 additions and 0 deletions.
  1. +2 −0 README.md
  2. +26 −0 UPGRADING.md
@@ -18,6 +18,8 @@ proxies and load balancers.
<img src="https://coveralls.io/repos/nodejitsu/node-http-proxy/badge.png?branch=caronte"/></a>
</p>
## Looking to Upgrade from 0.8.x ? Click [here](UPGRADING.md)
### Core Concept
A new proxy is created by calling `createProxyServer` and passing
@@ -0,0 +1,26 @@
`caronte` is a from-scratch implementation of `http-proxy` and, as such
brings some breaking changes to APIs.

## Server creation

Available through `.createServer()` or `.createProxyServer()`.
Check the README.md for a more detailed explanation of the parameters.

## Proxying

Web proying is done by calling the `.web()` method on a Proxy instance. Websockets
are proxied by the `.ws()` method.

## Error Handling

It is possible to listen globally on the `error` event on the server. In alternative, a
callback passed to `.web()` or `.ws()` as last parameter is also accepted.

## Dropped

Since the API was rewritten to be extremely flexible we decided to drop some features
which were in the core and delegate them to eventual "user-land" modules.

- Middleware API
- ProxyTable API

1 comment on commit db12f6c

@indexzero

This comment has been minimized.

Copy link
Member

indexzero commented on db12f6c Dec 20, 2013

@yawnt Nice start. A good next step would be to flesh it out with code examples and more specific language. This is a great place to look: http://nodejs.org/api/stream.html#stream_compatibility_with_older_node_versions

Please sign in to comment.