Skip to content

Commit

Permalink
improve README formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
Juliette Pretot committed Nov 19, 2019
1 parent 2a33e02 commit e47957d
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,15 @@

Test your web application with the [axe-core](https://github.com/dequelabs/axe-core) accessibility testing library. Results will show in the browser console.

## Usage
## Installation

Install the module from NPM.

```sh
npm install --save-dev agnostic-axe
```

## Initialize the module

Intialize the exported class.
## Usage

```js
if (process.env.NODE_ENV !== 'production') {
Expand All @@ -32,8 +30,8 @@ The `AxeReporter` constructor takes two optional parameters:

- The first optional parameter is `targetNode`, and determines which element is audited. It defaults to `document.body`.
- The second optional parameter is `analyseTimeout`, it determines the time within the element should be re-analyzed after a mutation was observed. It defaults to `1000` (1 second).
- The is a third optional parameter `axeConfig` is a configuration object for axe-core. Read about the object here at https://github.com/dequelabs/axe-core/blob/master/doc/API.md#api-name-axeconfigure and the see `agnostic-axe` source code for the default configuration.
- The is a third optional parameter `axeConfig` is a configuration object for [axe-core](https://github.com/dequelabs/axe-core). Read about the object at https://github.com/dequelabs/axe-core/blob/master/doc/API.md#api-name-axeconfigure and the see agnostic-axe source code for the default configuration.

### Credits
## Credits

Agnostic axe itself is merely a wrapper around [axe-core](https://github.com/dequelabs/axe-core) that employs a `MutationObserver` to detect DOM changes automatically. Most of its logic for formatting violations return by [axe-core](https://github.com/dequelabs/axe-core) is taken from [react-axe](https://github.com/dequelabs/react-axe)
Agnostic axe itself is merely a wrapper around [axe-core](https://github.com/dequelabs/axe-core) that employs a `MutationObserver` to detect DOM changes automatically. Most of its logic for formatting violations return by [axe-core](https://github.com/dequelabs/axe-core) is taken from [react-axe](https://github.com/dequelabs/react-axe).

0 comments on commit e47957d

Please sign in to comment.