Skip to content

Commit

Permalink
RENAME package & SYNC versions with monorepo && CHANGE readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ndelangen committed Nov 11, 2017
1 parent f3a8e48 commit 6fdc4e3
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 47 deletions.
9 changes: 0 additions & 9 deletions addons/a11y/.scripts/npm-prepublish.js

This file was deleted.

6 changes: 0 additions & 6 deletions addons/a11y/CHANGELOG.md

This file was deleted.

14 changes: 12 additions & 2 deletions addons/a11y/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ This storybook addon can be helpfull to make your UI components more accessibile

First, install the addon.

```shell
```sh
$ npm install -D storybook-addon-a11y
```

Add this line to your `addons.js` file (create this file inside your storybook config directory if needed).

```js
import 'storybook-addon-a11y/register';
import '@storybook/addon-a11y/register';
```

import the `'checkA11y'` decorator to check your stories for violations within your components.
Expand All @@ -39,3 +39,13 @@ storiesOf('button', module)
</button>
));
```

## Roadmap

* Make UI accessibile
* Add color blindness filters ([Example](http://lowvision.support/))
* Show in story where violations are.
* Make it configurable
* Add more example tests
* Add tests
* Make CI integration possible
7 changes: 0 additions & 7 deletions addons/a11y/ROADMAP.md

This file was deleted.

47 changes: 24 additions & 23 deletions addons/a11y/package.json
Original file line number Diff line number Diff line change
@@ -1,27 +1,34 @@
{
"name": "storybook-addon-a11y",
"version": "3.1.9",
"name": "@storybook/addon-a11y",
"version": "3.2.14",
"description": "a11y addon for storybook",
"main": "dist/index.js",
"scripts": {
"prepublish": "node .scripts/npm-prepublish.js",
"storybook": "start-storybook -p 9001",
"test": "jest"
"keywords": [
"a11y",
"accessibility",
"addon",
"storybook",
"valid",
"verify"
],
"homepage": "https://github.com/storybooks/storybook#readme",
"bugs": {
"url": "https://github.com/storybooks/storybook/issues"
},
"license": "MIT",
"main": "dist/index.js",
"repository": {
"type": "git",
"url": "git+https://github.com/storybooks/storybook-addon-a11y.git"
"url": "git+https://github.com/storybooks/storybook.git"
},
"keywords": [
"storybook"
],
"license": "MIT",
"bugs": {
"url": "https://github.com/storybooks/storybook-addon-a11y/issues"
"scripts": {
"prepare": "node ../../scripts/prepare.js"
},
"dependencies": {
"@storybook/react": "^3.2.14",
"axe-core": "^2.0.7",
"prop-types": "^15.5.10"
},
"homepage": "https://github.com/storybooks/storybook-addon-a11y#readme",
"devDependencies": {
"@storybook/react": "^3.0.0",
"babel-cli": "^6.14.0",
"babel-jest": "^15.0.0",
"babel-polyfill": "^6.13.0",
Expand All @@ -31,17 +38,11 @@
"lodash": "^4.16.2",
"react": "^15.5.4",
"react-addons-test-utils": "^15.3.2",
"react-dom": "^15.5.4",
"shelljs": "^0.7.7"
"react-dom": "^15.5.4"
},
"peerDependencies": {
"@storybook/addons": "^3.0.0",
"react": "*",
"react-dom": "*"
},
"dependencies": {
"@storybook/react": "^3.0.0",
"axe-core": "^2.0.7",
"prop-types": "^15.5.10"
}
}

0 comments on commit 6fdc4e3

Please sign in to comment.