Skip to content

Commit ba1e5ee

Browse files
authored
Update README.md
1 parent 53a7647 commit ba1e5ee

1 file changed

Lines changed: 11 additions & 5 deletions

File tree

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,21 @@ steps:
1313
files: scripts/*.sh
1414
```
1515
16-
## Options
16+
## Configuration
1717
18-
### `files`
18+
### Required
1919
20-
The files (or globs) to run shellcheck on
20+
### `files` (string or array of strings)
2121

22-
### `options`
22+
The files (or globs) to run shellcheck on.
2323

24-
Any options to pass to shellcheck
24+
### Optional
25+
26+
### `options` (string or array of strings)
27+
28+
Command line options to pass to shellcheck.
29+
30+
Default: `"--color=always"`
2531

2632
## License
2733

0 commit comments

Comments
 (0)