docs: add extra flags to README

TheDevMinerTV · Sep 19, 2023 · 1466e9d · 1466e9d
1 parent 58b23dd
commit 1466e9d
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/.dockerignore b/.dockerignore
@@ -1,4 +1,5 @@
 /.github
 /.git
 /renovate.json
-/Dockerfile
+/Dockerfile
+/README.md
diff --git a/README.md b/README.md
@@ -5,3 +5,13 @@ Probably the fastest (and simplest) way to serve static files.
 ```bash
 docker run --rm -p 8080:80 -v $PWD:/static:ro ghcr.io/thedevminertv/gostatic
 ```
+
+Additionally, you can add the following flags:
+
+```bash
+-cache <duration> # Enable caching
+-compress-level <level> # Enable compression (-1=remove module, 0=none, 2=best)
+-log-requests # Log requests (this will slow down the server by ~40%)
+```
+
+You can just add these to the end of the `docker run` command.