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 <fandree@amazon.com>
This commit is contained in:
Andreea Florescu
2020-03-23 16:41:19 +02:00
committed by Laura Loghin
parent 460020a10f
commit e89ed14707

24
README.md Normal file
View File

@@ -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.