Add example/README.md

x-color · May 16, 2021 · 077d254 · 077d254
1 parent 479a2cd
commit 077d254
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/example/README.md b/example/README.md
@@ -0,0 +1,10 @@
+# Example
+
+```sh
+$ cfn-doc sample-template.yaml > sample-template.yaml.md
+# or
+$ cfn-doc -o sample-template.yaml.md sample-template.yaml
+```
+
+- Generated document: [sample-template.yaml.md](https://github.com/x-color/cfn-doc/blob/main/example/sample-template.yaml.md)
+- Source template: [sample-template.yaml](https://github.com/x-color/cfn-doc/blob/main/example/sample-template.yaml)