Update CLI docs in README

Matthew Holt committed Oct 1, 2019 at 20:45 UTC 370b78c5c77404620523d6036d08716402fbf709

1 file changed +7 -7

README.md

+7 -7

@@ -42,7 +42,7 @@ $ go build

43 That will put a `caddy(.exe)` binary into the current directory. You can move it into your PATH or use `go install` to do that automatically (assuming `$GOPATH/bin` is already in your PATH). You can also use `go run main.go` for quick, temporary builds while developing.

45 -The initial build may be slow as dependencies are downloaded. Subsequent builds should be very fast. If you encounter any Go-module-related errors, try clearing your Go module cache (`$GOPATH/pkg/mod`) and read [the Go wiki page about modules for help](https://github.com/golang/go/wiki/Modules). If you have issues with Go modules, please consult the Go community for help. But if there is an actual error in Caddy, please report it to us.

45 +The initial build may be slow as dependencies are downloaded. Subsequent builds should be very fast. If you encounter any Go-module-related errors, try clearing your Go module cache (`$GOPATH/pkg/mod`) and Go package cache (`$GOPATH/pkg`) and read [the Go wiki page about modules for help](https://github.com/golang/go/wiki/Modules). If you have issues with Go modules, please consult the Go community for help. But if there is an actual error in Caddy, please report it to us.

48 ## Quick Start

@@ -127,25 +127,25 @@ reverse_proxy /api localhost:9005

127 file_server

128 ```

129

130 -Instead of being its primary mode of configuration, an internal _config adapter_ adapts the Caddyfile to Caddy's native JSON structure. You can see it in action with the [`adapt-config` command](https://github.com/caddyserver/caddy/wiki/v2:-Documentation#adapt-config):

130 +Instead of being its primary mode of configuration, an internal _config adapter_ adapts the Caddyfile to Caddy's native JSON structure. You can see it in action with the [`adapt` command](https://github.com/caddyserver/caddy/wiki/v2:-Documentation#adapt):

131

132 ```bash

133 -$ ./caddy adapt-config --input path/to/Caddyfile --adapter caddyfile --pretty

133 +$ ./caddy adapt --config path/to/Caddyfile --adapter caddyfile --pretty

134 ```

135

136 -But if you just want to run Caddy with your Caddyfile directly, the CLI wraps this up for you nicely. Either of the following commands:

136 +If you just want to run Caddy with your Caddyfile directly, the CLI wraps this up for you nicely. Either of the following commands:

137

138 ```bash

139 $ ./caddy start

140 $ ./caddy run

141 ```

142

143 -will apply your Caddyfile if it is called `Caddyfile` in the current directory.

143 +will use your Caddyfile if it is called `Caddyfile` in the current directory.

144

145 If your Caddyfile is somewhere else, you can still use it:

146

147 ```bash

148 -$ ./caddy start|run --config path/to/Caddyfile --config-adapter caddyfile

148 +$ ./caddy start|run --config path/to/Caddyfile --adapter caddyfile

149 ```

150

151 [Learn more about the Caddyfile in v2.](https://github.com/caddyserver/caddy/wiki/v2:-Documentation#caddyfile-adapter)

@@ -250,7 +250,7 @@ Yes! Caddy's native JSON configuration via API is nice when you are automating c

250

251 The v2 Caddyfile is very similar to the v1 Caddyfile, but they are not compatible. Several improvements have been made to request matching and directives in v2, giving you more power with less complexity and fewer inconsistencies.

252

253 -Caddy's default _config adapter_ is the Caddyfile adapter. This takes a Caddyfile as input and [outputs the JSON config](https://github.com/caddyserver/caddy/wiki/v2:-Documentation#adapt-config). You can even run Caddy directly without having to see or think about the underlying JSON config.

253 +Caddy's default _config adapter_ is the Caddyfile adapter. This takes a Caddyfile as input and [outputs the JSON config](https://github.com/caddyserver/caddy/wiki/v2:-Documentation#adapt). You can even run Caddy directly without having to see or think about the underlying JSON config.

254

255 The following _config adapters_ are already being built or plan to be built:

256