From ac00a89c929daf021fd20b5cd4fc0e49a4ccdecb Mon Sep 17 00:00:00 2001 From: Dirkjan Ochtman Date: Tue, 24 Apr 2018 13:33:19 +0200 Subject: [PATCH] Add README --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 000000000..2d83bed4b --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# Quinn + +Quinn is an implementation of the [QUIC][quic] protocol based on futures. +It is currently in its very early stages: work is ongoing on implementing +the protocol handshake for both client and server. + +Quinn is the subject of a [RustFest Paris (May 2018) presentation][talk]. + +All feedback welcome. Feel free to file bugs, requests for documentation and +any other feedback to the [issue tracker][issues] or [tweet me][twitter]. + +# Features + +* Currently targets QUIC draft 10 and TLS 1.3 draft 23 +* Uses [rustls][rustls] for all TLS operations +* Uses [*ring*][ring] for AEAD encryption/decryption + +[quic]: https://quicwg.github.io/ +[issues]: https://github.com/djc/quinn/issues +[twitter]: https://twitter.com/djco/ +[rustls]: https://github.com/ctz/rustls +[ring]: https://github.com/briansmith/ring +[talk]: https://paris.rustfest.eu/sessions/a-quic-future-in-rust