From e85f1c42c5c7411fb04fe10144718ff353f30897 Mon Sep 17 00:00:00 2001
From: xenia <xenia@awoo.systems>
Date: Tue, 23 Apr 2024 18:37:49 -0400
Subject: [PATCH] update readme

---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/README.md b/README.md
index 67bf8d9..95e8bcb 100644
--- a/README.md
+++ b/README.md
@@ -160,6 +160,23 @@ pkgs.fetchFromSteam {
 }
 ```
 
+### `mkNginxServer`
+
+creates a shell script that launches nginx in the foreground as the current user. the nginx is
+configured to run an http server on `localhost:8080` with the given `siteConfig`
+
+example:
+```nix
+pkgs.mkNginxServer {
+  siteConfig = ''
+    location / {
+      root path/to/development_site_root;
+      error_page 404 /404.html;
+    }
+  '';
+}
+```
+
 ## licensing
 
 this repository is NOT licensed under a "standard" FOSS license. instead, it uses