Skip to content

Commit db12f6c

Browse files
committed
[docs] add UPGRADING.md
1 parent 16828a9 commit db12f6c

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

Diff for: README.md

+2
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ proxies and load balancers.
1818
<img src="https://coveralls.io/repos/nodejitsu/node-http-proxy/badge.png?branch=caronte"/></a>
1919
</p>
2020

21+
## Looking to Upgrade from 0.8.x ? Click [here](UPGRADING.md)
22+
2123
### Core Concept
2224

2325
A new proxy is created by calling `createProxyServer` and passing

Diff for: UPGRADING.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
`caronte` is a from-scratch implementation of `http-proxy` and, as such
2+
brings some breaking changes to APIs.
3+
4+
## Server creation
5+
6+
Available through `.createServer()` or `.createProxyServer()`.
7+
Check the README.md for a more detailed explanation of the parameters.
8+
9+
## Proxying
10+
11+
Web proying is done by calling the `.web()` method on a Proxy instance. Websockets
12+
are proxied by the `.ws()` method.
13+
14+
## Error Handling
15+
16+
It is possible to listen globally on the `error` event on the server. In alternative, a
17+
callback passed to `.web()` or `.ws()` as last parameter is also accepted.
18+
19+
## Dropped
20+
21+
Since the API was rewritten to be extremely flexible we decided to drop some features
22+
which were in the core and delegate them to eventual "user-land" modules.
23+
24+
- Middleware API
25+
- ProxyTable API
26+

0 commit comments

Comments
 (0)