Skip to content

Commit ebdfc9d

Browse files
authored
Merge pull request #35 from github/kh-update-readme
Update README with extension recommendation and note
2 parents 0ff6beb + c9f1890 commit ebdfc9d

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,3 +56,12 @@ linters:
5656
bundle install
5757
bundle exec rake
5858
```
59+
60+
## Recommended extension
61+
62+
If you use VS Code, we highly encourage [ERB Linter extension](https://marketplace.visualstudio.com/items?itemName=manuelpuyol.erb-linter) to see immediate feedback in your editor.
63+
64+
## Note
65+
66+
This repo contains several accessibility-related linting rules to help surface accessibility issues that would otherwise go undetected until a later stage. Please note that due to the limitations of static code analysis,
67+
these ERB accessibility checks are NOT enough for ensuring the accessibility of your app. This shouldn't be the only tool you use to catch accessibility issues and should be supplemented with other tools that can check the runtime browser DOM output, as well as processes like accessibility design reviews, manual audits, user testing, etc.

0 commit comments

Comments
 (0)