Skip to content

Commit 27bad9b

Browse files
committed
Update README.md
1 parent faf44db commit 27bad9b

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,12 @@
1818

1919
# eslint-plugin-jsx-a11y
2020

21-
A static analysis linter of jsx and its accessibility to all users.
21+
Static AST checker for accessibility rules on JSX elements.
22+
23+
## Why?
24+
Ryan Florence built out this awesome runtime-analysis tool called [react-a11y](https://github.com/reactjs/react-a11y). It is pretty awesome. However, this creates more package-bloat and requries initialization in your code. Since you're probably already using linting in your project, this plugin comes for free and closer to actual development. Pairing this plugin with an editor lint plugin, you can bake accessibility standards into your application in real-time.
25+
26+
Note: This project does not *replace* react-a11y, but can and should be used in conjunction with it. Static analysis tools cannot determine values of variables that are being placed in props before runtime, so linting will not fail if that value is undefined and/or does not pass the lint rule.
2227

2328
## Installation
2429

0 commit comments

Comments
 (0)