From 79a7e6d572d9debdb81ad286fdd669cc88d8c1dd Mon Sep 17 00:00:00 2001 From: Dan Adajian Date: Fri, 26 May 2023 11:11:02 -0500 Subject: [PATCH] docs: add usage instructions for comparadise-utils --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index d367b890..d4bbfdb3 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,15 @@ In a Cypress test that renders your component or visits your site, use `cy.match This will take a screenshot of whatever Cypress is currently displaying, compare it to a `base.png` that was previously downloaded from S3, and output a `diff.png` and `new.png` if there is a visual change. +### comparadise-utils Usage + +In `cypress/support/commands.ts`: + +```ts +import 'comparadise-utils/commands'; +import 'comparadise-utils/types'; +``` + ## Executing Your Visual Tests Usage: