From 9ab0e1f7e2bf7e4853fcbcccb821f09c05f720fc Mon Sep 17 00:00:00 2001
From: CrazyMax <crazy-max@users.noreply.github.com>
Date: Sat, 31 Jul 2021 08:30:20 +0200
Subject: [PATCH] readme for example

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
---
 example/README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)
 create mode 100644 example/README.md

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`