Skip to content
This repository was archived by the owner on Nov 18, 2024. It is now read-only.

Commit 15a516a

Browse files
committed
docs(readme): add example above config to make it clear those are unnecessary
1 parent a4ce0e7 commit 15a516a

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,22 @@
2727
<br />
2828
</div>
2929

30+
## Dead Simple
31+
32+
As easy as the following, and even the more advanced features are just a few extra lines.
33+
34+
```yml
35+
name: "my-workflow"
36+
on: [pull_request]
37+
38+
jobs:
39+
eslint:
40+
runs-on: ubuntu-latest
41+
steps:
42+
- uses: actions/checkout@v3
43+
- uses: bradennapier/eslint-plus-action@v3
44+
```
45+
3046
## Features
3147
3248
- :tada: [**Works on Forked PR's Securely!**](https://github.com/bradennapier/eslint-plus-action#handle-forked-prs) :tada:

0 commit comments

Comments
 (0)