aboutsummaryrefslogtreecommitdiff
path: root/examples/headers/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'examples/headers/README.md')
-rw-r--r--examples/headers/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/examples/headers/README.md b/examples/headers/README.md
new file mode 100644
index 0000000..01c243a
--- /dev/null
+++ b/examples/headers/README.md
@@ -0,0 +1,16 @@
+# HTTP headers example
+
+This example shows a HTTP/1.1 server that listens to port `8080` and prints
+the headers received from the client (up to a maximum of `max_headers`) to
+standard output.
+
+## How to build
+
+If using `make(1)`, just run `make` from this directory.
+
+If using CMake, examples are built by default when configuring the project
+from [the top-level `CMakeLists.txt`](../../CMakeLists.txt).
+
+## How to run
+
+Run the executable without any command line arguments.