Add Readme

This commit is contained in:
Mark Spanbroek 2020-09-03 10:26:46 +02:00
parent 5936c89813
commit 3ed06e148d
1 changed files with 38 additions and 0 deletions

38
Readme.md Normal file
View File

@ -0,0 +1,38 @@
QUIC for Nim
============
We're working towards an implementation of the
[QUIC](https://datatracker.ietf.org/wg/quic/about/) protocol for
[Nim](https://nim-lang.org/). This is very much a work in progress, and not yet
in a usable state.
Roadmap
-------
This is a rough outline of the steps that we expect to take during
implemenation. They are bound to change over time.
First, we're going to wrap an existing C library for QUIC, to test the future
native Nim implementation against, and to explore what a Nim API should look
like.
Wrap existing library:
- [ ] Interface with TLS library
- [ ] Open connection
- [ ] Create stream
- [ ] Send data
- [ ] Close stream
- [ ] Close connection
- [ ] Stream multiplexing
- [ ] Connection multiplexing
Then we'd like to implement QUIC in Nim itself:
- [ ] Open connection
- [ ] Create stream
- [ ] Send data
- [ ] Close stream
- [ ] Close connection
- [ ] Flow control
- [ ] Stream multiplexing
- [ ] Congestion control
- [ ] Connection multiplexing