diff --git a/README.md b/README.md index 935bd7f5..9029f87b 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,27 @@ [![Version](https://img.shields.io/npm/v/@percy/storybook.svg)](https://npmjs.org/package/@percy/storybook) ![Test](https://github.com/percy/percy-storybook/workflows/Test/badge.svg) -[Percy](https://percy.io) visual testing for [Storybook](https://storybook.js.org). +## Visual Testing with Percy + +[Percy](https://percy.io) is an all-in-one visual testing and review platform. It captures screenshots, compares them against the baseline, and highlights visual changes. With increased visual coverage, teams can deploy code changes with confidence with every commit. + +[Storybook](https://storybook.js.org) supports cross-browser visual testing natively using Percy. You can use Percy for visual testing of web applications on desktop and mobile browsers. + +The benefits of utilizing Percy for visual testing include the following: + +- Efficiency: Improves efficiency by reducing the time and effort required to manually spot visual regressions. +- Consistency: Promotes consistent user experience by identifying visual discrepancies early in the development process. +- Integrations: Percy integrates with popular tools and services like GitHub, GitLab, Bitbucket, and more. +- Collaboration: Improves collaboration between developers, designers, and QA teams by providing a visual representation of changes. +Prevent regression: Prevents you from experiencing unintended visual regressions. + +## How does Percy work? + +Percy compares new snapshots against relevant baselines to detect visual changes. Percy manages baseline picking across branches so your tests are always relevant. If visual changes are detected, Percy highlights and groups the resulting diffs for you to review. + +# Integrate your Storybook tests with Percy +Before integration, you can explore [Percy’s sample build tutorial for Storybook.](https://www.browserstack.com/docs/percy/sample-build/storybook) +Integrate your Storybook automated tests with BrowserStack Percy and here's an overview of the integration steps: ## Installation diff --git a/package.json b/package.json index 128a7d33..b683e081 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,14 @@ { "name": "@percy/storybook", + "description": "Storybook addons for visual testing with Percy", + "keywords": [ + "storybook-addons", + "visual", + "visual-testing", + "layout-testing", + "percy", + "image-testing" + ], "version": "5.0.1", "license": "MIT", "repository": { @@ -33,6 +42,10 @@ "test:env": "cross-env NODE_ENV=test NODE_OPTIONS='--loader=./test/loader.js'", "test:coverage": "nyc yarn test" }, + "storybook": { + "displayName": "Percy", + "icon": "https://avatars.githubusercontent.com/u/12260884" + }, "@percy/cli": { "commands": [ "./dist/storybook.js"