mirrors/uquic
1
0
Fork 0
mirror of https://github.com/refraction-networking/uquic.git synced 2025-04-04 20:57:36 +03:00
Code Issues Projects Releases Packages Wiki Activity

minor readme updates

Browse source
This commit is contained in:
Lucas Clemente 2016-08-02 10:44:12 +02:00
parent 41ce637f53
commit 348c5ae8e8
1 changed files with 3 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -7,7 +7,7 @@
[![Windows Build Status](https://img.shields.io/appveyor/ci/lucas-clemente/quic-go.svg?style=flat-square&label=windows+build)](https://ci.appveyor.com/project/lucas-clemente/quic-go/branch/master) [![Windows Build Status](https://img.shields.io/appveyor/ci/lucas-clemente/quic-go.svg?style=flat-square&label=windows+build)](https://ci.appveyor.com/project/lucas-clemente/quic-go/branch/master)
[![Code Coverage](https://img.shields.io/codecov/c/github/lucas-clemente/quic-go/master.svg?maxAge=2592000&style=flat-square)](https://codecov.io/gh/lucas-clemente/quic-go/) [![Code Coverage](https://img.shields.io/codecov/c/github/lucas-clemente/quic-go/master.svg?maxAge=2592000&style=flat-square)](https://codecov.io/gh/lucas-clemente/quic-go/)
quic-go is an implementation of the [QUIC](https://en.wikipedia.org/wiki/QUIC) protocol in Go. While we're not far from being feature complete, there's still a lot of work to do regarding performance and security. At the moment, we do not recommend use in production systems. We appreciate any feedback :) quic-go is an implementation of the [QUIC](https://en.wikipedia.org/wiki/QUIC) protocol in Go. While we're not far from being feature complete, there's still work to do regarding performance and security. At the moment, we do not recommend use in production systems. We appreciate any feedback :)
## Roadmap ## Roadmap
@ -15,7 +15,7 @@ Done:
- Basic protocol with support for QUIC version 32-34 - Basic protocol with support for QUIC version 32-34
- HTTP/2 support - HTTP/2 support
- Crypto (RSA / ECDSA certificates, curve25519 for key exchange, AES-GCM or Chacha20-Poly1305 as stream cipher) - Crypto (RSA / ECDSA certificates, Curve25519 for key exchange, AES-GCM or Chacha20-Poly1305 as stream cipher)
- Loss detection and retransmission (currently fast retransmission & RTO) - Loss detection and retransmission (currently fast retransmission & RTO)
- Flow Control - Flow Control
- Congestion control using cubic - Congestion control using cubic
@ -27,8 +27,6 @@ Major TODOs:
- Better packet loss detection - Better packet loss detection
- Connection migration - Connection migration
- QUIC client - QUIC client
- Public API design
- Integration into caddy (mostly to figure out the right server API)
## Guides ## Guides
@ -54,7 +52,7 @@ Using Chrome:
## Usage ## Usage
See the [example server](example/main.go) or the current beta version of [Caddy](https://github.com/mholt/caddy) ([instructions here](https://github.com/mholt/caddy/wiki/QUIC)). Starting a QUIC server is very similar to the standard lib http in go: See the [example server](example/main.go) or try out [Caddy](https://github.com/mholt/caddy) (from version 0.9, [instructions here](https://github.com/mholt/caddy/wiki/QUIC)). Starting a QUIC server is very similar to the standard lib http in go:
```go ```go
http.Handle("/", http.FileServer(http.Dir(wwwDir))) http.Handle("/", http.FileServer(http.Dir(wwwDir)))