Skip to content

Commit 23eb188

Browse files
README: mention the supported use cases (#48)
1 parent 70172dd commit 23eb188

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,13 @@
33
[![PkgGoDev](https://pkg.go.dev/badge/github.com/quic-go/connect-ip-go)](https://pkg.go.dev/github.com/quic-go/connect-ip-go)
44
[![Code Coverage](https://img.shields.io/codecov/c/github/quic-go/connect-ip-go/master.svg?style=flat-square)](https://codecov.io/gh/quic-go/connect-ip-go/)
55

6-
connect-ip-go is a partial implementation of the CONNECT-IP protocol [RFC 9484](https://datatracker.ietf.org/doc/html/rfc9484), based on [quic-go](https://github.com/quic-go/quic-go). It provides both a client and a proxy implementation.
6+
connect-ip-go is an implementation of the CONNECT-IP protocol [RFC 9484](https://datatracker.ietf.org/doc/html/rfc9484), allowing the proxying of IP packets in HTTP/3.
7+
8+
It is based on [quic-go](https://github.com/quic-go/quic-go), and provides both a client and a proxy implementation.
9+
10+
At this point, it supports the following use cases:
11+
* Remote Access VPN, see [Section 8.1 of RFC 9484](https://datatracker.ietf.org/doc/html/rfc9484#section-8.1)
12+
* Site-to-Site VPN, see [Section 8.2 of RFC 9484](https://datatracker.ietf.org/doc/html/rfc9484#section-8.2)
713

814

915
## Release Policy

0 commit comments

Comments
 (0)