From 42b0da66ccb483d724e89e7f76496bb4bce4ab49 Mon Sep 17 00:00:00 2001
From: Silas Rech <silas@panascais.net>
Date: Fri, 25 Mar 2022 11:05:00 +0100
Subject: [PATCH] Add git ref documentation

Closes #87
---
 README.md | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 9f716b1..028affc 100644
--- a/README.md
+++ b/README.md
@@ -53,7 +53,12 @@ $ xcaddy build [<caddy_version>]
     [--with <module[@version][=replacement]>...]
 ```
 
-- `<caddy_version>` is the core Caddy version to build; defaults to `CADDY_VERSION` env variable or latest.
+- `<caddy_version>` is the core Caddy version to build; defaults to `CADDY_VERSION` env variable or latest.<br>
+  This can be the keyword `latest`, which will use the latest stable tag, or any git ref such as:
+  - A tag like `v2.0.1`
+  - A branch like `master`
+  - A commit like `a58f240d3ecbb59285303746406cab50217f8d24`
+
 - `--output` changes the output file.
 - `--with` can be used multiple times to add plugins by specifying the Go module name and optionally its version, similar to `go get`. Module name is required, but specific version and/or local replacement are optional.
 
@@ -66,6 +71,12 @@ $ xcaddy build \
 $ xcaddy build v2.0.1 \
     --with github.com/caddyserver/ntlm-transport@v0.1.1
 
+$ xcaddy build master \
+    --with github.com/caddyserver/ntlm-transport
+
+$ xcaddy build a58f240d3ecbb59285303746406cab50217f8d24 \
+    --with github.com/caddyserver/ntlm-transport
+
 $ xcaddy build \
     --with github.com/caddyserver/ntlm-transport=../../my-fork