From e89ed1470791dd7922ac736117aa41a316168897 Mon Sep 17 00:00:00 2001 From: Andreea Florescu Date: Mon, 23 Mar 2020 16:41:19 +0200 Subject: [PATCH] added readme file The readme is still WIP, but it was added so that we can have links to the other documents in the repository. Signed-off-by: Andreea Florescu --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..7163a4c --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# micro-http + +This is a minimal implementation of the +[HTTP/1.0](https://tools.ietf.org/html/rfc1945) and +[HTTP/1.1](https://www.ietf.org/rfc/rfc2616.txt) protocols. This HTTP +implementation is stateless thus it does not support chunking or compression. + +The micro-http implementation is used in production by Firecracker. + +## Contributing + +To contribute to micro-http, checkout the +[contribution guidelines](CONTRIBUTING.md). + +## Releases + +New micro-http versions are released via the GitHub repository releases page. A +history of changes is recorded in our [changelog](CHANGELOG.md). + +## Policy for Security Disclosures + +If you suspect you have uncovered a vulnerability, contact us privately, as +outlined in our [security policy document](); we will immediately prioritize +your disclosure. \ No newline at end of file