Skip to content

Commit

Permalink
Update README to mention that users needs to install stylelint
Browse files Browse the repository at this point in the history
  • Loading branch information
haya14busa committed Sep 23, 2019
1 parent f369123 commit 543b30c
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,17 @@ Optional. It's same as `--config` flag of stylelint.

## Example usage

You also need to install [stylelint](https://github.com/stylelint/stylelint).

```shell
# Example
$ npm install stylelint stylelint-config-recommended -D
```

You can create [stylelint
config](https://github.com/stylelint/stylelint/blob/master/docs/user-guide/configuration.md)
and this action uses that config too.

### [.github/workflows/reviewdog.yml](.github/workflows/reviewdog.yml)

```yml
Expand All @@ -53,6 +64,6 @@ jobs:
uses: reviewdog/action-stylelint@v1
with:
github_token: ${{ secrets.github_token }}
reporter: github-pr-review # Change reporter.
reporter: github-pr-review # Change reporter.
stylelint_input: '**/*.css'
```

0 comments on commit 543b30c

Please sign in to comment.