Skip to content

Commit 9bee146

Browse files
committed
docs: improve installation info
1 parent 7bdebc4 commit 9bee146

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,10 +69,22 @@ require('@frsource/cypress-plugin-visual-regression-diff/dist/support');
6969
- seconds time, in your plugins file (located by default in `cypress/plugins/index.js`):
7070
```ts
7171
// typescript
72-
import '@frsource/cypress-plugin-visual-regression-diff/src/plugins';
72+
import { initPlugin } from '@frsource/cypress-plugin-visual-regression-diff/src/plugins';
73+
74+
export default function (on: Cypress.PluginEvents, config: Cypress.PluginConfigOptions) {
75+
initPlugin(on, config);
76+
77+
return config;
78+
};
7379

7480
// javascript
75-
require('@frsource/cypress-plugin-visual-regression-diff/dist/plugins');
81+
const { initPlugin } = require('@frsource/cypress-plugin-visual-regression-diff/dist/plugins');
82+
83+
module.exports = function (on, config) {
84+
initPlugin(on, config);
85+
86+
return config;
87+
}
7688
```
7789

7890
That's it - now let's see how to use the library in [usage section](#usage).

0 commit comments

Comments
 (0)