Skip to content

Commit a8a38e1

Browse files
mchamwmcode
authored andcommitted
docs(readme): updated readme to pub
1 parent 30a3d44 commit a8a38e1

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@ Test accessibility with [axe-core](https://github.com/dequelabs/axe-core) in [Cy
66

77
> ### Forked from [cypress-axe](https://github.com/component-driven/cypress-axe)
88
>
9-
> **Reasons**: to upgrade dependencies (i.e. `Cypress ^7` & `axe-core ^4`) and try out some of the suggesions in [RFC 75](https://github.com/component-driven/cypress-axe/issues/75) 👀
9+
> **Reasons**:
10+
>
11+
> - to upgrade dependencies (i.e. `Cypress ^7` & `axe-core ^4`)
12+
> - [RFC 75](https://github.com/component-driven/cypress-axe/issues/75) 👀
1013
1114
1. [Installation and Setup](#Installation-and-Setup)
1215
- [Typescript](#TypeScript)
@@ -94,8 +97,8 @@ it('passes axe', () => {
9497

9598
## Customised
9699

97-
Leveraging [Cypress commands](https://docs.cypress.io/api/cypress-api/custom-commands), you can create your own custom command that calls `cy.checkA11y` with the config you want.
98-
For example, if you only want to assert against _serious_ & _critical_ violations but ignore _color-contrast_ rule, you can do something like this:
100+
Leveraging [Cypress commands](https://docs.cypress.io/api/cypress-api/custom-commands), you can create your own custom command that calls `cy.checkA11y` with the config you want. For example, if you only want to assert against _serious_ & _critical_ violations but ignore _color-contrast_ rule, you can do something like this:
101+
99102
```js
100103
// cypress/support/commands.js
101104
Cypress.Commands.add(

0 commit comments

Comments
 (0)