aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5556f06
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+# cgifun
+
+Just an extremely simple example of a CGI program with caddy web server and zig as the CGI program.
+
+To run:
+* Have caddy with [CGI plugin](https://caddyserver.com/docs/modules/http.handlers.cgi)
+* Have [zig](https://ziglang.org/download/) programming language.
+* `zig build && caddy run`
+* Open http://localhost:8080 in your browser
+
+You'll see a webpage full of environment variables which are passed as part of the CGI protocol to the cgifun program. \ No newline at end of file