aboutsummaryrefslogtreecommitdiff
path: root/examples/put/README.md
diff options
context:
space:
mode:
authorxavi <xavi@noreply.localhost>2023-11-20 16:47:53 +0100
committerxavi <xavi@noreply.localhost>2023-11-20 16:47:53 +0100
commitb94f76033f72d4eba629a6473a2b301dd7988f97 (patch)
treeadac8adce7dc9ce6c0f880c0439cd9f3b39527ab /examples/put/README.md
parent8f1ad3124e9e063ca0ee7c2548c747b20de3529d (diff)
parentdc8b14d99028b9235aa7d7633906a979aa08e4f9 (diff)
downloadlibweb-b94f76033f72d4eba629a6473a2b301dd7988f97.tar.gz
Merge pull request 'Add support for HTTP `PUT`' (#3) from midokura-xavi/libweb:put into master
Reviewed-on: https://gitea.privatedns.org/xavi/libweb/pulls/3
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.