docs(README): add documents about input parameters (#98)

- `tflint_target_dir` - `tflint_config` Signed-off-by: Rintaro Okamura <[email protected]>
reviewdog · Aug 19, 2024 · b61e666 · b61e666
1 parent 0a8c6a4
commit b61e666
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -80,6 +80,16 @@ Default is `` (empty).
 Optional. Whether to run `tflint --init` prior to linting (useful if you have a .tflint.hcl with some values in it).
 The default is `false`.
 
+### `tflint_target_dir`
+
+Optional. The target dir for the tflint command. This is the directory passed to tflint as opposed to working_directory which is the directory the command is executed from.
+The default is `.`.
+
+### `tflint_config`
+
+Optional. Config file name for tflint.
+The default is `.tflint.hcl`
+
 ### `flags`
 
 Optional. List of arguments to send to `tflint`.