README.md revision 50aadb33 
1LiteSpeed QUIC (LSQUIC) Client Library README
2=============================================
3
4Description
5-----------
6
7LiteSpeed QUIC (LSQUIC) Client Library is an open-source implementation
8of QUIC functionality for clients.  It is released in the hope to speed
9the adoption of QUIC.  Most of the code in this distribution is used in
10our own products: LiteSpeed Web Server and ADC.  We think it is free of
11major problems.  Nevertheless, do not hesitate to report bugs back to us.
12Even better, send us fixes and improvements!
13
14Currently supported QUIC versions are Q035, Q037, Q038, Q039, and Q040.
15Support for newer versions will be added soon after they are released.
16The version(s) specified by IETF QUIC WG will be added once the IETF
17version of the protocol settles down a little.
18
19Documentation
20-------------
21
22The documentation for this module is admittedly sparse.  The API is
23documented in include/lsquic.h.  If you have doxygen, you can run
24`doxygen dox.cfg' or `make docs'.  The example program is
25test/http_client.c: a bare-bones, but working, QUIC client.  Have a look
26in EXAMPLES.txt to see how it can be used.
27
28Building
29--------
30
31To build LSQUIC, you need CMake and BoringSSL.  The example program
32uses libevent to provide the event loop.  In short:
33
34  cmake -DBORINGSSL_INCLUDE=/some/dir -DBORINGSSL_LIB=/some/other/dir .
35
36Have fun,
37
38LiteSpeed QUIC Team.
39
40Copyright (c) 2017 LiteSpeed Technologies Inc
41