diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..52f3019 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# mediocre-caddy-plugins + +TODO proper introduction + +## Development + +A nix-based development environment is provided with the correct versions of all +development dependencies. It can be activated by doing: + +``` +nix-shell -A shell +``` + +The `./cmd/mediocre-caddy` binary package can be used to run a Caddy instance +with all plugins provided by this package pre-installed. + +The Caddyfile `./example/Caddyfile` can be used to spin up a Caddy instance with +various virtual-hosts predefined with usefule configurations for testing. See +that file for a description of the available virtual hosts. + +``` +go run ./cmd/mediocre-caddy run --config ./example/Caddyfile +``` |