Skip to content

Commit 9fc9516

Browse files
Guilherme Beltramininosborn
authored andcommitted
Change order of parameters and make explicit what is optional
1 parent 1436aa2 commit 9fc9516

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,19 @@ Basic usage with all options enabled:
1111
- name: markdownlint-cli
1212
uses: nosborn/[email protected]
1313
with:
14-
config_file: ".markdownlint.yaml"
1514
files: .
15+
config_file: ".markdownlint.yaml"
1616
ignore_files: "examples/ignore/*"
1717
rules: "examples/rules/custom.js"
1818

1919
```
2020

2121
## Inputs
2222

23-
* `config_file` - configuration file (JSON or YAML)
24-
* `files` - what to process, this is required - files, directories, globs
25-
* `ignore_files` - files to ignore/exclude - file, directory, glob
26-
* `rules` - custom rule files - file, directory, glob, package
23+
* `files` - what to process (files, directories, globs)
24+
* `config_file` (optional) - configuration file (JSON or YAML)
25+
* `ignore_files` (optional) - files to ignore/exclude (file, directory, glob)
26+
* `rules` (optional) - custom rule files (file, directory, glob, package)
2727

2828
## License
2929

0 commit comments

Comments
 (0)