Skip to content

Commit 841a350

Browse files
authored
fix: add how to install and use to README
1 parent 7884f70 commit 841a350

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,18 @@
33
44
**Note:** currently the built site is served statically and tested _without proxying redirects_.
55

6+
## Install and use
7+
8+
*note:* this plugin assumes you have already installed Cypress as a dev NPM dependency.
9+
10+
```shell
11+
npm install --save-dev netlify-plugin-cypress
12+
# or
13+
yarn add -D netlify-plugin-cypress
14+
```
15+
16+
And then add the plugin's name to the list of build plugins in `netlify.yml` file as shown in the examples below.
17+
618
## Examples
719

820
### basic
@@ -75,7 +87,7 @@ Set environment variable `DEBUG=netlify-plugin-cypress` to see the debug logs. T
7587

7688
<details>
7789
<summary>Cypress binary is missing</summary>
78-
If you see error messages from `cypress` NPM module <code>Error: The cypress npm package is installed, but the Cypress binary is missing.</code> add to your repository <code>package.json</code> scripts <code>"postinstall": "cypress install"</code> command.
90+
If you see error messages from `cypress` NPM module <code>Error: The cypress npm package is installed, but the Cypress binary is missing.</code> add to your repository <code>package.json</code> scripts <code>"postinstall": "cypress install"</code> command. See <a href="https://github.com/cypress-io/netlify-plugin-cypress-example/blob/master/package.json">netlify-plugin-cypress-example</a> for instance.
7991
</details>
8092

8193
<details>

0 commit comments

Comments
 (0)