File tree Expand file tree Collapse file tree 2 files changed +12
-1
lines changed Expand file tree Collapse file tree 2 files changed +12
-1
lines changed Original file line number Diff line number Diff line change @@ -52,6 +52,17 @@ where your Terraform module is located.
5252
5353## Usage
5454
55+ #### Generic
56+ ``` bash
57+ Usage: docker run cytopia/terraform-docs terraform-docs < ARGS> .
58+ docker run cytopia/terraform-docs terraform-docs-replace < ARGS> < PATH-TO-FILE>
59+
60+ terraform-docs Output as expected from terraform-docs
61+ terraform-docs-replace Same as above, but replaces directly inside README.md
62+ if DELIM_START and DELIM_CLOSE are found.
63+ < ARGS> All arguments terraform-docs command can use.
64+ ` ` `
65+
5566# ### Output to stdout
5667Create markdown output and sent to stdout:
5768` ` ` bash
Original file line number Diff line number Diff line change @@ -111,7 +111,7 @@ if [ "${#}" -ge "1" ]; then
111111 else
112112 >&2 echo " Error, Unsupported command."
113113 >&2 echo " Usage: cytopia/terraform-docs terraform-docs <ARGS> ."
114- >&2 echo " cytopia/terraform-docs terraform-docs-replace <ARGS>"
114+ >&2 echo " cytopia/terraform-docs terraform-docs-replace <ARGS> <PATH-TO-FILE> "
115115 >&2 echo
116116 >&2 echo " terraform-docs Output as expected from terraform-docs"
117117 >&2 echo " terraform-docs-replace Same as above, but replaces directly inside README.md"
You can’t perform that action at this time.
0 commit comments