Skip to content

Commit

Permalink
docs: legacy api
Browse files Browse the repository at this point in the history
  • Loading branch information
benmonro committed Jun 12, 2020
1 parent 511d073 commit 742e1bf
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,3 +60,19 @@ test('Automated accessibility testing', async () => {
// do stuff with violations.
});
```

## Legacy API

This project was forked from [axe-testcafe](https://github.com/helen-dikareva/axe-testcafe) which has been dormant for quite some time. If you prefer to use that API you can still use that:

```js
import { axeCheck, createReport } from 'axe-testcafe';

fixture `TestCafe tests with Axe`
.page `http://example.com`;

test('Automated accessibility testing', async t => {
const { error, violations } = await axeCheck(t);
await t.expect(violations.length === 0).ok(createReport(violations));
});
```

0 comments on commit 742e1bf

Please sign in to comment.