diff --git a/README.md b/README.md index e69de29..aec1f6b 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,35 @@ +# Simple compose runner + +A simple docker compose runner in Go. + +### Building + +``` +go build +``` + +### Usage + +Run a compose in current directory + +``` +./compose-runner +``` + +Run a compose in current directory, verbose output + +``` +./compose-runner -v +``` + +Run a compose at specified location + +``` +./compose-runner /path/to/repo +``` + +Run a compose at specified location, verbose output + +``` +./compose-runner -v /path/to/repo +``` \ No newline at end of file