Skip to content

Commit

Permalink
Change order of parameters and make explicit what is optional
Browse files Browse the repository at this point in the history
  • Loading branch information
Guilherme Beltramini authored and nosborn committed Dec 29, 2019
1 parent 1436aa2 commit 9fc9516
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Expand Up @@ -11,19 +11,19 @@ Basic usage with all options enabled:
- name: markdownlint-cli
uses: nosborn/github-action-markdown-cli@v1.1.1
with:
config_file: ".markdownlint.yaml"
files: .
config_file: ".markdownlint.yaml"
ignore_files: "examples/ignore/*"
rules: "examples/rules/custom.js"

```

## Inputs

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

## License

Expand Down

0 comments on commit 9fc9516

Please sign in to comment.