summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTEC <git@tecosaur.net>2024-01-09 22:56:14 +0800
committerTEC <git@tecosaur.net>2024-01-09 22:56:14 +0800
commitc44967b14da2a81226c6fe515a6a6436280459d8 (patch)
treebfa7326ebda6034e1ab9a52b97c02cc8834d8320
parentc81c68cfe601fe3cf7555b6527532db13617345a (diff)
downloadcaddy-fs-git-c44967b14da2a81226c6fe515a6a6436280459d8.tar.zst
Update readme
-rw-r--r--README.org18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.org b/README.org
index c3acfa4..f8d0984 100644
--- a/README.org
+++ b/README.org
@@ -10,3 +10,21 @@ Build Caddy using [[https://github.com/caddyserver/xcaddy][xcaddy]]
#+begin_src sh
xcaddy build --with github.com/tecosaur/caddy-fs-git
#+end_src
+
+* Usage
+
+#+begin_src caddyfile
+file_server {
+ fs git <path/to/repo.git>
+}
+#+end_src
+
+#+begin_src caddyfile
+file_server {
+ fs git {
+ repository <path/to/repo.git>
+ revision HEAD # the default revision
+ }
+}
+#+end_src
+