Skip to content

Commit 11bfb67

Browse files
committed
README++
1 parent 1be9ba5 commit 11bfb67

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ This module provides an `http.Agent` implementation that connects to a specified
77
HTTP or HTTPS proxy server, and can be used with the built-in `https` module.
88

99
Specifically, this `Agent` implementation connects to an intermediary "proxy"
10-
server and issues the CONNECT HTTP method, which tells the proxy to open a
11-
direct TCP connection to the endpoint server.
10+
server and issues the [CONNECT HTTP method][CONNECT], which tells the proxy to
11+
open a direct TCP connection to the destination server.
1212

1313
Since this agent implements the CONNECT HTTP method, it also works with other
1414
protocols that use this method when connecting over proxies (i.e. WebSockets).
@@ -100,7 +100,7 @@ API
100100

101101
The `HttpsProxyAgent` class implements an `http.Agent` subclass that connects
102102
to the specified "HTTP(s) proxy server" in order to proxy HTTPS and/or WebSocket
103-
requests. This is achieved by using the HTTP `CONNECT` method.
103+
requests. This is achieved by using the [HTTP `CONNECT` method][CONNECT].
104104

105105
The `opts` argument may either be a string URI of the proxy server to use, or an
106106
"options" object with more specific properties:
@@ -137,3 +137,5 @@ IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
137137
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
138138
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
139139
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
140+
141+
[CONNECT]: http://en.wikipedia.org/wiki/HTTP_tunnel#HTTP_CONNECT_Tunneling

0 commit comments

Comments
 (0)