Skip to content

Commit

Permalink
Add requirements to readme and peer deps
Browse files Browse the repository at this point in the history
  • Loading branch information
ahuth committed Nov 5, 2021
1 parent 9648a5a commit 369431e
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 9 deletions.
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ If there are any violations, information about them will be printed, and the com

## Table of contents

- [Project goals](#project-goals)
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [Options](#options)
Expand All @@ -18,15 +18,12 @@ If there are any violations, information about them will be printed, and the com
- [Developing](#developing)
- [Inspiration](#inspiration)

## Project goals
## Requirements

These will be used to determine development work and direction, and triage bugs and pull requests.

1. Run axe-core on Storybook stories written in [Component Story Format](https://storybook.js.org/docs/react/api/csf).
2. Run on CI as automated accessibility tests.
3. Also be useful for humans to run on local machines.
3. Have reasonable performance. It doesn't have to maximize speed, but needs to be fast enough that people will actually use it.
4. Allow people to adopt incrementally. For example, by allowing rules to be disabled.
Using this package requires
- Node 12 or up
- Storybook 6.4 or up (for previous versions of Storybook, use axe-storybook-testing v4.1.3)
- axe-core 4.0 or up

## Installation

Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@
"zod": "^3.9.8"
},
"peerDependencies": {
"@storybook/preview-web": "^6.4.0-beta.28",
"axe-core": "^4.0.0"
},
"devDependencies": {
Expand Down

0 comments on commit 369431e

Please sign in to comment.