aboutsummaryrefslogtreecommitdiff
path: root/examples/put/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'examples/put/README.md')
-rw-r--r--examples/put/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/examples/put/README.md b/examples/put/README.md
new file mode 100644
index 0000000..afa9191
--- /dev/null
+++ b/examples/put/README.md
@@ -0,0 +1,18 @@
+# HTTP `PUT` example
+
+This example shows a minimal setup for an application using `libweb` that only
+accepts `PUT` requests. When executed, it starts a HTTP/1.1 server on a random
+port that shall be printed to standard output. When a `PUT` request is received,
+`libweb` shall store the body into a file in the `/tmp` directory, and print the
+path of the temporary file to the 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.