Skip to content

Commit

Permalink
docs: add note about supported environments (#1492)
Browse files Browse the repository at this point in the history
Add a note in the Support Browsers section about being able to run when features are natively supported or polyfilled correctly.

Closes: #1136 

## Reviewer checks

**Required fields, to be filled out by PR reviewer(s)**
- [x] Follows the commit message policy, appropriate for next version
- [x] Has documentation updated, a DU ticket, or requires no documentation change
- [x] Includes new tests, or was unnecessary
- [x] Code is reviewed for security by: @JKODU
  • Loading branch information
straker authored and WilcoFiers committed Apr 11, 2019
1 parent f79663f commit c5cd24a
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,8 @@ Support means that we will fix bugs and attempt to test each browser regularly.

There is limited support for JSDOM. We will attempt to make all rules compatible with JSDOM but where this is not possible, we recommend turning those rules off. Currently the `color-contrast` rule is known not to work with JSDOM.

We can only support environments where features are either natively supported or polyfilled correctly.

## The Accessibility Rules

The complete list of rules run by axe-core can be found in [doc/rule-descriptions.md](./doc/rule-descriptions.md).
Expand Down

0 comments on commit c5cd24a

Please sign in to comment.