diff --git a/README.md b/README.md index a8762886..533a8179 100644 --- a/README.md +++ b/README.md @@ -207,7 +207,7 @@ Support this project with a :star: | diff\_relative | string | false | `"true"` | Exclude changes outside the current
directory and show path names
relative to it. **NOTE:** This
requires you to specify the
top level directory via the
`path` input. | | dir\_names | string | false | `"false"` | Output unique changed directories instead
of filenames. **NOTE:** This returns
`.` for changed files located
in the root of the
project. | | dir\_names\_exclude\_root | string | false | `"false"` | Exclude the root directory represented
by `.` from the output
when `dir_names`is set to `true`. | -| dir\_names\_max\_depth | string | false | | Maximum depth of directories to
output. e.g `test/test1/test2` with max
depth of `2` returns `test/test1`. | +| dir\_names\_max\_depth | string | false | | Limit the directory output to
a maximum depth e.g `test/test1/test2`
with max depth of `2`
returns `test/test1`. | | escape\_json | string | false | `"true"` | Escape JSON output. | | fetch\_depth | string | false | `"50"` | Depth of additional branch history
fetched. **NOTE**: This can be
adjusted to resolve errors with
insufficient history. | | files | string | false | | File and directory patterns to
detect changes using only these
list of file(s) (Defaults to the entire repo) **NOTE:**
Multiline file/directory patterns should not
include quotes. |