diff --git a/README.md b/README.md index 9162061..e0203ed 100644 --- a/README.md +++ b/README.md @@ -11,8 +11,8 @@ 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" @@ -20,10 +20,10 @@ Basic usage with all options enabled: ## 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