README.md
1# QUICHE
2
3QUICHE stands for QUIC, Http, Etc. It is Google's production-ready
4implementation of QUIC, HTTP/2, HTTP/3, and related protocols and tools. It
5powers Google's servers, Chromium, Envoy, and other projects. It is actively
6developed and maintained.
7
8There are two public QUICHE repositories. Either one may be used by embedders,
9as they are automatically kept in sync:
10
11* https://quiche.googlesource.com/quiche
12* https://github.com/google/quiche
13
14To embed QUICHE in your project, platform APIs need to be implemented and build
15files need to be created. Note that it is on the QUICHE team's roadmap to
16include default implementation for all platform APIs and to open-source build
17files. In the meanwhile, take a look at open source embedders like Chromium and
18Envoy to get started:
19
20* [Platform implementations in Chromium](https://source.chromium.org/chromium/chromium/src/+/main:net/third_party/quiche/overrides/quiche_platform_impl/)
21* [Build file in Chromium](https://source.chromium.org/chromium/chromium/src/+/main:net/third_party/quiche/BUILD.gn)
22* [Platform implementations in Envoy](https://github.com/envoyproxy/envoy/tree/master/source/common/quic/platform)
23* [Build file in Envoy](https://github.com/envoyproxy/envoy/blob/main/bazel/external/quiche.BUILD)
24
25To contribute to QUICHE, follow instructions at
26[CONTRIBUTING.md](CONTRIBUTING.md).
27
28QUICHE is only supported on little-endian platforms.
29