Skip to content

Commit acd51cd

Browse files
authored
Merge pull request #37 from rstavchansky/patch-1
Update README.md
2 parents 73dedb1 + d1410a0 commit acd51cd

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
Run your critical pages through [pa11y](https://github.com/pa11y/pa11y) and fail build if accessibility failures are found.
44

5-
> NOTICE: This is a [Netlify Build](https://github.com/netlify/build) plugin, which is in public beta. You must have Netlify Build enabled to use this plugin.
6-
75
## Demo
86

97
The demo site is a Gatsby blog that has been modified to have some inaccessible elements: https://netlify-plugin-a11y.netlify.com/
@@ -24,7 +22,9 @@ But if that is too drastic, you can switch to `resultMode = "warn"` so that buil
2422

2523
## Usage
2624

27-
To install, add the following lines to your `netlify.toml` file:
25+
To install the plugin in the Netlify UI, use this [direct in-app installation link](https://app.netlify.com/plugins/netlify-plugin-a11y/install) or go to the [Plugins directory](https://app.netlify.com/plugins).
26+
27+
For file-based installation, add the following lines to your `netlify.toml` file:
2828

2929
```toml
3030
[[plugins]]
@@ -52,12 +52,10 @@ package = "netlify-plugin-a11y"
5252
# debugMode = true # extra logging for plugin developers
5353
```
5454

55-
### Including this plugin in a project
56-
57-
This plugin can be included via npm. Install it as a dependency for your project like so:
55+
To complete file-based installation, from your project's base directory, use npm, yarn, or any other Node.js package manager to add the plugin to `devDependencies` in `package.json`.
5856

59-
```
60-
npm install --save netlify-plugin-a11y
57+
```bash
58+
npm install -D netlify-plugin-a11y
6159
```
6260

6361
### Execution in Netlify

0 commit comments

Comments
 (0)