Skip to content

Commit

Permalink
Merge pull request #15 from ctrf-io/fix/incorrect-installation-ins
Browse files Browse the repository at this point in the history
docs: amend installation instructions
  • Loading branch information
Ma11hewThomas authored May 29, 2024
2 parents 1ded946 + e074c64 commit 80ee3e1
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,13 +67,13 @@ Add the reporter to your cypress.config.js/ts file:

```javascript
const { defineConfig } = require('cypress')
const { generateCtrfJsonReport } = require('cypress-ctrf-json-report')
const { GenerateCtrfReport } = require('cypress-ctrf-json-reporter')

module.exports = defineConfig({
e2e: {
setupNodeEvents(on, config) {
// Implement node event listeners here
GenerateCtrfReport({
new GenerateCtrfReport({
on,
})
},
Expand All @@ -94,7 +94,7 @@ You'll find a JSON file named `ctrf-report.json` in the `ctrf` directory.
Add the reporter to your cypress/plugins/index.js/ts

```javascript
const { generateCtrfJsonReport } = require('cypress-ctrf-json-report')
const { GenerateCtrfReport } = require('cypress-ctrf-json-reporter');

/// <reference types="cypress" />

Expand All @@ -103,9 +103,9 @@ const { generateCtrfJsonReport } = require('cypress-ctrf-json-report')
*/
// eslint-disable-next-line no-unused-vars
module.exports = (on, config) => {
GenerateCtrfReport({
new GenerateCtrfReport({
on,
})
});
}
```

Expand All @@ -114,7 +114,7 @@ module.exports = (on, config) => {
The reporter supports several configuration options:

```javascript
GenerateCtrfReport({
new GenerateCtrfReport({
on, {
outputFile: 'custom-name.json', // Optional: Output file name. Defaults to 'ctrf-report.json'.
outputDir: 'custom-directory', // Optional: Output directory path. Defaults to 'ctrf'.
Expand Down

0 comments on commit 80ee3e1

Please sign in to comment.