Skip to content

Commit

Permalink
Update documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
ygerasimov committed Jul 25, 2024
1 parent 7f13c63 commit c4a9915
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@

Diffy is a visual regression testing service https://diffy.website. It is primary tailored to testing Drupal and WordPress websites.

This repository is a recepie for DDEV to have a local worker that will allow taking screenshots from local website and upload them to Diffy for further comparisons.
This repository is a recipe for DDEV to have a local worker that will allow taking screenshots from local website and upload them to Diffy for further comparisons.

## Installation

Add this addon as `ddev get diffywebsite/ddev-diffy`.

Register an account in Diffy and create an API key. Add the key as API_KEY environmental variable.
Register an account in Diffy and create an API key. While installation of the addon you will be asked for API KEY and PROJECT ID. Please provide them so configuration is saved.

Create a project in Diffy and save its ID as PROJECT_ID environmental variable.
To run the screenshots do `ddev screenshot`. It will produce a URL to your screenshots uploaded to Diffy. Next you can compare them to your any other sets (production, staging, baseline etc.).

**Contributed and maintained by [@ygerasimov](https://github.com/ygerasimov)**

0 comments on commit c4a9915

Please sign in to comment.