Skip to content

Commit

Permalink
Read me changed
Browse files Browse the repository at this point in the history
  • Loading branch information
helen-dikareva committed Jun 7, 2017
1 parent 2829342 commit b3ffdf5
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 11 deletions.
17 changes: 7 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# axe-testcafe
The helper for using Axe in TestCafe tests
The TestCafe module that allows you to use the [aXe](https://github.com/dequelabs/axe-core) accessibility engine in TestCafe tests.

## How to install it?
## Installation

```bash
npm install axe-testcafe
```

## How to use it?
## How to use

You can write a TestCafe test with automated accessibility checks like this.
You can write a TestCafe test with automated accessibility checks like this.

```js
import axeCheck from 'axe-testcafe';
Expand All @@ -22,14 +22,13 @@ test('Automated accessibility testing', async t => {
});
```

If some accessibility problems are found, you will see the corresponding error.
If any accessibility issues are found, you will see a detailed report.

![Accessibility errors](https://github.com/helen-dikareva/axe-testcafe/blob/master/errors.png)

## Axe options
## aXe options

Please see the [Axe run](https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#api-name-axerun) method API.
You can define `context` and `options` in a TestCafe test:
The `axe-testcafe` module allows you to define the `context` and `options` [axe.run parameters](https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#api-name-axerun) in a TestCafe test.

```js
test('Automated accessibility testing', async () => {
Expand All @@ -38,5 +37,3 @@ test('Automated accessibility testing', async () => {

await axeCheck(t, axeContext, axeOptions);
});

```
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "axe-testcafe",
"version": "0.0.1",
"description": "The helper for using Axe in TestCafe tests",
"description": "The TestCafe module that allows you to use the aXe accessibility engine in TestCafe tests",
"main": "index.js",
"repository": {
"type": "git",
Expand Down

0 comments on commit b3ffdf5

Please sign in to comment.