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.
52
52
53
53
## Usage
54
54
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
+
55
66
# ### Output to stdout
56
67
Create markdown output and sent to stdout:
57
68
` ` ` bash
Original file line number Diff line number Diff line change @@ -111,7 +111,7 @@ if [ "${#}" -ge "1" ]; then
111
111
else
112
112
>&2 echo " Error, Unsupported command."
113
113
>&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> "
115
115
>&2 echo
116
116
>&2 echo " terraform-docs Output as expected from terraform-docs"
117
117
>&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