From 61173cc2cb8102972457acebdc6ad2e659701099 Mon Sep 17 00:00:00 2001 From: Lucas Clemente Date: Tue, 11 Apr 2017 17:35:34 +0200 Subject: [PATCH] Update readme and add a contributing section --- README.md | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index d15a8aed1..4916e33d2 100644 --- a/README.md +++ b/README.md @@ -14,17 +14,10 @@ quic-go is an implementation of the [QUIC](https://en.wikipedia.org/wiki/QUIC) p quic-go is compatible with the current version(s) of Google Chrome and QUIC as deployed on Google's servers. We're actively tracking the development of the Chrome code to ensure compatibility as the protocol evolves. In that process, we're dropping support for old QUIC versions. As Google's QUIC versions are expected to converge towards the [IETF QUIC draft](https://github.com/quicwg/base-drafts), quic-go will eventually implement that draft. -quic-go should be built with Go 1.7 or newer. - -Major TODOs: - -- Better packet loss detection -- Connection migration -- Client-side 0-RTT support -- BBR congestion control - ## Guides +We currently support Go 1.7+. + Installing deps: go get -t @@ -69,3 +62,7 @@ http.Client{ Transport: &h2quic.QuicRoundTripper{}, } ``` + +## Contributing + +We are always happy to welcome new contributors! We have a number of self-contained issues that are suitable for first-time contributors, they are tagged with [want-help](https://github.com/lucas-clemente/quic-go/issues?q=is%3Aopen+is%3Aissue+label%3Awant-help). If you have any questions, please feel free to reach out by opening an issue or leaving a comment.