Mirrors/xcaddy
1
0
Fork 0
mirror of https://github.com/caddyserver/xcaddy.git synced 2024-10-07 11:40:11 +01:00
Code Issues Projects Releases Packages Wiki Activity

Update readme

Browse source
This commit is contained in:
Matthew Holt 2020-05-02 18:22:59 -06:00
parent 9146f00342
commit 446eab4eb6
No known key found for this signature in database
GPG key ID: 2A349DD577D586A5
1 changed files with 9 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -16,6 +16,14 @@ Stay updated, be aware of changes, and please submit feedback! Thanks!
- [Go installed](https://golang.org/doc/install)
- [Go modules](https://github.com/golang/go/wiki/Modules) enabled
## Install
You can [download binaries](https://github.com/caddyserver/xcaddy/releases) that are already compiled for your platform, or build `xcaddy` from source:
```bash
$ go get -u github.com/caddyserver/xcaddy/cmd/xcaddy
```
## Command usage
@ -24,15 +32,9 @@ The `xcaddy` command has two primary uses:
- Compile custom `caddy` binaries
- A replacement for `go run` while developing Caddy plugins
Install the `xcaddy` command with:
```bash
$ go get -u github.com/caddyserver/xcaddy/cmd/xcaddy
```
The `xcaddy` command will use the latest version of Caddy by default. You can customize this for all invocations by setting the `CADDY_VERSION` environment variable.
As usual with `go` command, the `xcaddy` command will pass through the `GOOS`, `GOARCH`, and `GOARM` environment variables for cross-compilation.
As usual with `go` command, the `xcaddy` command will pass the `GOOS`, `GOARCH`, and `GOARM` environment variables through for cross-compilation.
### Custom builds