simon/tiny_httpd
1
0
Fork 0
mirror of https://github.com/c-cube/tiny_httpd.git synced 2025-12-07 11:45:36 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

readme

Browse source
This commit is contained in:
Simon Cruanes 2021-07-18 00:05:44 -04:00
parent 3848b25aae
commit 6c810fb0ed
1 changed files with 8 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -3,8 +3,10 @@
Minimal HTTP server using good old threads, with stream abstractions, Minimal HTTP server using good old threads, with stream abstractions,
simple routing, URL encoding/decoding, and optional compression with camlzip. simple routing, URL encoding/decoding, and optional compression with camlzip.
It also supports [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events)
([w3c](https://html.spec.whatwg.org/multipage/server-sent-events.html#event-stream-interpretation))
Free from all forms of `ppx`, async monads, etc. Free from all forms of `ppx`, async monads, etc. 🙃
**Note**: it can be useful to add the `jemalloc` opam package for long running **Note**: it can be useful to add the `jemalloc` opam package for long running
server, as it does a good job at controlling memory usage. server, as it does a good job at controlling memory usage.
@ -75,11 +77,11 @@ dependencies or high scalability libraries.
Use cases might include: Use cases might include:
- serve content directly from a static blog generator - serve content directly from a static blog generator;
- provide a web UI to some tool (like CUPS and syncthing do) - provide a web UI to some tool (like CUPS and syncthing do);
- implement a basic monitoring page for a service - implement a basic monitoring page for a service;
- provide a simple json API for a service, on top of http - provide a simple json API for a service, on top of http;
- use `http_of_dir` to serve odoc-generated docs or some assets directory - use `http_of_dir` to serve odoc-generated docs or some assets directory.
## Documentation ## Documentation