Skip to content

Commit

Permalink
Adds docs for missing inputs in README.md (#37)
Browse files Browse the repository at this point in the history
  • Loading branch information
aruke committed Mar 29, 2023
1 parent 0169eb4 commit 6355501
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,16 @@ Optional. Runs checks against the baseline file provided.
Optional. Defines the [ktlint](https://ktlint.github.io/) version to use.
The default value is `latest`.

### `name`

Optional. Reviewdog report name. See [checkstyle-format](https://github.com/reviewdog/reviewdog/tree/master#checkstyle-format) for details.
The default value is `ktlint`.

### `file_glob`

Optional. Defines a file glob to identify files to be checked.
The default value is an empty string.

## Example usage

```yml
Expand Down

0 comments on commit 6355501

Please sign in to comment.