diff --git a/example/README.md b/example/README.md new file mode 100644 index 0000000..a4d5e7d --- /dev/null +++ b/example/README.md @@ -0,0 +1,12 @@ +# Example + +The following example will generate YAML and Markdown for [Docker buildx](https://github.com/docker/buildx) CLI plugin. + +```console +git clone https://github.com/docker/docgen +cd docgen/example/ +go mod download +go run main.go +``` + +Generated docs will be available in `./docs`