Update readme

This commit is contained in:
Matthew Holt 2020-05-07 13:01:33 -06:00
parent 43fba378d6
commit c8da8ca673
No known key found for this signature in database
GPG key ID: 2A349DD577D586A5

View file

@ -64,7 +64,6 @@
Requirements: Requirements:
- [Go 1.14 or newer](https://golang.org/dl/) - [Go 1.14 or newer](https://golang.org/dl/)
- Do NOT disable [Go modules](https://github.com/golang/go/wiki/Modules) (`export GO111MODULE=on`)
### For development ### For development
@ -81,7 +80,7 @@ _**Note:** These steps [will not embed proper version information](https://githu
Using [our builder tool](https://github.com/caddyserver/xcaddy)... Using [our builder tool](https://github.com/caddyserver/xcaddy)...
``` ```
$ xcaddy build <caddy_version> $ xcaddy build
``` ```
...the following steps are automated: ...the following steps are automated:
@ -90,8 +89,9 @@ $ xcaddy build <caddy_version>
2. Change into it: `cd caddy` 2. Change into it: `cd caddy`
3. Copy [Caddy's main.go](https://github.com/caddyserver/caddy/blob/master/cmd/caddy/main.go) into the empty folder. Add imports for any custom plugins you want to add. 3. Copy [Caddy's main.go](https://github.com/caddyserver/caddy/blob/master/cmd/caddy/main.go) into the empty folder. Add imports for any custom plugins you want to add.
4. Initialize a Go module: `go mod init caddy` 4. Initialize a Go module: `go mod init caddy`
5. Pin Caddy version: `go get github.com/caddyserver/caddy/v2@TAG` replacing `TAG` with a git tag or commit. You can also pin any plugin versions similarly. 5. (Optional) Pin Caddy version: `go get github.com/caddyserver/caddy/v2@TAG` replacing `TAG` with a git tag or commit.
6. Compile: `go build` 6. (Optional) Add plugins by adding their import: `_ "IMPORT_PATH"`
7. Compile: `go build`