From c8b2d00673f0c6f7b8c3a71e2713e6c981226639 Mon Sep 17 00:00:00 2001 From: Francis Lavoie Date: Fri, 3 Sep 2021 21:36:13 -0400 Subject: [PATCH] docs: Update README to mention `xcaddy version`, cleanup (#71) --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c4ec61a..9f716b1 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,6 @@ This command line tool and associated Go package makes it easy to make custom bu It is used heavily by Caddy plugin developers as well as anyone who wishes to make custom `caddy` binaries (with or without plugins). -⚠️ Still in development. Supports Caddy 2 only. - Stay updated, be aware of changes, and please submit feedback! Thanks! ## Requirements @@ -27,7 +25,7 @@ For Debian, Ubuntu, and Raspbian, an `xcaddy` package is available from our [Clo ```bash sudo apt install -y debian-keyring debian-archive-keyring apt-transport-https -curl -1sLf 'https://dl.cloudsmith.io/public/caddy/xcaddy/gpg.key' | sudo apt-key add - +curl -1sLf 'https://dl.cloudsmith.io/public/caddy/xcaddy/gpg.key' | sudo tee /etc/apt/trusted.gpg.d/caddy-xcaddy.asc curl -1sLf 'https://dl.cloudsmith.io/public/caddy/xcaddy/debian.deb.txt' | sudo tee /etc/apt/sources.list.d/caddy-xcaddy.list sudo apt update sudo apt install xcaddy @@ -84,6 +82,7 @@ $ xcaddy build \ This allows you to hack on Caddy core (and optionally plug in extra modules at the same time!) with relative ease. + ### For plugin development If you run `xcaddy` from within the folder of the Caddy plugin you're working on _without the `build` subcommand_, it will build Caddy with your current module and run it, as if you manually plugged it in and invoked `go run`. @@ -110,6 +109,13 @@ $ xcaddy run --config caddy.json The race detector can be enabled by setting `XCADDY_RACE_DETECTOR=1`. The DWARF debug info can be enabled by setting `XCADDY_DEBUG=1`. +### Getting `xcaddy`'s version + +``` +$ xcaddy version +``` + + ## Library usage ```go