Skip to content

Commit 5a9e765

Browse files
committed
updated readme to include settings and better description
1 parent bf87ecf commit 5a9e765

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# vue-axe
22

3-
Accessibility auditing for Vue.js applications (Inspired by [dequelabs/react-axe](https://github.com/dequelabs/react-axe))
3+
Accessibility auditing for Vue.js applications by running [dequelabs/axe-core](https://github.com/dequelabs/axe-core/) validation on the page your viewing, `axe-core` will run 1 second after the last VueJS update (with a 5 seconds debounce max wait). Package inspired by [dequelabs/react-axe](https://github.com/dequelabs/react-axe).
44

55
## Install package
66
#### NPM
@@ -32,9 +32,11 @@ if (process.env.NODE_ENV !== 'production') {
3232
})
3333
}
3434
```
35-
36-
Optional: You can also pass settings through the second parameter at the time of installing the plugin, read about the object here:
37-
https://github.com/dequelabs/axe-core/blob/master/doc/API.md#api-name-axeconfigure
35+
#### Configuration
36+
|Key|Description|Default|Required|
37+
|---|---|---|---|
38+
|`clearConsoleOnUpdate`|Clears the console each time `vue-axe` runs|`true`|`false`|
39+
|`config`|Provide your Axe-core configuration: https://github.com/dequelabs/axe-core/blob/master/doc/API.md#api-name-axeconfigure| |`false`|
3840

3941
## Install in Nuxt.js
4042
Create plugin file `plugins/axe.js`

0 commit comments

Comments
 (0)