Add an explanatory comment to example Caddyfile as well

caddyserver · Sep 20, 2024 · 3342e48 · 3342e48
1 parent b4bdc6b
commit 3342e48
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -122,6 +122,9 @@ You may embed directories into the Caddy executable and serve them from the `emb
 $ xcaddy build --embed foo:./sites/foo --embed bar:./sites/bar
 $ cat Caddyfile
 {
+    # You must declare a custom filesystem using the `embedded` module.
+    # The first argument to `filesystem` is an arbitrary identifier
+    # that will also be passed to `fs` directives.
     filesystem my_embeds embedded
 }