From 7f750c5081012e9eb423f75dacb0d11d7436fc4c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Greg=20Berg=C3=A9?= Date: Thu, 28 Nov 2024 10:33:52 +0100 Subject: [PATCH] docs: update all readmes --- examples/circleci/README.md | 7 ++++++- examples/cypress/README.md | 7 ++++++- examples/github-actions/README.md | 7 ++++++- examples/nextjs/README.md | 7 ++++++- examples/playwright/README.md | 7 ++++++- examples/puppeteer/README.md | 7 ++++++- examples/remix/README.md | 7 ++++++- examples/storybook-legacy/README.md | 7 ++++++- examples/storybook/README.md | 7 ++++++- examples/travis/README.md | 7 ++++++- examples/webdriver-io/README.md | 7 ++++++- packages/browser/README.md | 7 +++++-- packages/cli/README.md | 7 +++++-- packages/core/README.md | 7 +++++-- packages/playwright/README.md | 7 +++++-- packages/storybook/README.md | 7 +++++-- packages/util/README.md | 7 +++++-- 17 files changed, 96 insertions(+), 23 deletions(-) diff --git a/examples/circleci/README.md b/examples/circleci/README.md index 94254426..e6178bed 100644 --- a/examples/circleci/README.md +++ b/examples/circleci/README.md @@ -1,9 +1,14 @@

- Argos + + + Argos +

+

The open source visual testing plaform for modern engineering teams.

+ # Example of Argos running on CircleCI This example showcases Argos Visual Testing running on [CircleCI](https://circleci.com/). diff --git a/examples/cypress/README.md b/examples/cypress/README.md index fcbb1ea3..806e02fc 100644 --- a/examples/cypress/README.md +++ b/examples/cypress/README.md @@ -1,9 +1,14 @@

- Argos + + + Argos +

+

The open source visual testing plaform for modern engineering teams.

+ # Example of Argos + Cypress This example showcases Argos Visual Testing integrated to [Cypress](https://www.cypress.io/) testing framework. diff --git a/examples/github-actions/README.md b/examples/github-actions/README.md index a155bb16..ec5eb073 100644 --- a/examples/github-actions/README.md +++ b/examples/github-actions/README.md @@ -1,9 +1,14 @@

- Argos + + + Argos +

+

The open source visual testing plaform for modern engineering teams.

+ # Example of Argos running on GitHub Actions This example showcases Argos Visual Testing running on [GitHub Actions](https://github.com/features/actions). diff --git a/examples/nextjs/README.md b/examples/nextjs/README.md index 90a53583..826e43dc 100644 --- a/examples/nextjs/README.md +++ b/examples/nextjs/README.md @@ -1,9 +1,14 @@

- Argos + + + Argos +

+

The open source visual testing plaform for modern engineering teams.

+ # Example of Argos + Next.js This example showcases Argos Visual Testing integrated to [Next.js](https://nextjs.org/). diff --git a/examples/playwright/README.md b/examples/playwright/README.md index c72bcb4b..139ce005 100644 --- a/examples/playwright/README.md +++ b/examples/playwright/README.md @@ -1,9 +1,14 @@

- Argos + + + Argos +

+

The open source visual testing plaform for modern engineering teams.

+ # Example of Argos + Playwright This example showcases Argos Visual Testing integrated to [Playwright](https://playwright.dev/) testing framework. diff --git a/examples/puppeteer/README.md b/examples/puppeteer/README.md index 47b1c5a3..b4dbecc3 100644 --- a/examples/puppeteer/README.md +++ b/examples/puppeteer/README.md @@ -1,9 +1,14 @@

- Argos + + + Argos +

+

The open source visual testing plaform for modern engineering teams.

+ # Example of Argos + Puppeteer This example showcases Argos Visual Testing integrated to [Puppeteer](https://pptr.dev/). diff --git a/examples/remix/README.md b/examples/remix/README.md index f2845d33..0b3edbf4 100644 --- a/examples/remix/README.md +++ b/examples/remix/README.md @@ -1,9 +1,14 @@

- Argos + + + Argos +

+

The open source visual testing plaform for modern engineering teams.

+ # Example of Argos + Remix This example showcases Argos Visual Testing integrated to [Remix](https://remix.run/). diff --git a/examples/storybook-legacy/README.md b/examples/storybook-legacy/README.md index cb911032..8360bf94 100644 --- a/examples/storybook-legacy/README.md +++ b/examples/storybook-legacy/README.md @@ -1,9 +1,14 @@

- Argos + + + Argos +

+

The open source visual testing plaform for modern engineering teams.

+ # Example of Argos + Storybook and Storycap This example showcases Argos Visual Testing integrated to [Storybook](https://storybook.js.org/) using [Storycap](https://github.com/reg-viz/storycap) to capture screenshots. diff --git a/examples/storybook/README.md b/examples/storybook/README.md index 8fdbcf79..386a92fe 100644 --- a/examples/storybook/README.md +++ b/examples/storybook/README.md @@ -1,9 +1,14 @@

- Argos + + + Argos +

+

The open source visual testing plaform for modern engineering teams.

+ # Example of Argos + Storybook This example showcases Argos Visual Testing integrated to [Storybook](https://storybook.js.org/) testing framework. diff --git a/examples/travis/README.md b/examples/travis/README.md index 404b30f0..699ba771 100644 --- a/examples/travis/README.md +++ b/examples/travis/README.md @@ -1,9 +1,14 @@

- Argos + + + Argos +

+

The open source visual testing plaform for modern engineering teams.

+ # Example of Argos running on Travis This example showcases Argos Visual Testing running on [Travis](https://www.travis-ci.com/). diff --git a/examples/webdriver-io/README.md b/examples/webdriver-io/README.md index 967b1d9c..a0542cb9 100644 --- a/examples/webdriver-io/README.md +++ b/examples/webdriver-io/README.md @@ -1,9 +1,14 @@

- Argos + + + Argos +

+

The open source visual testing plaform for modern engineering teams.

+ # Example of Argos + WebdriverIO This example showcases Argos Visual Testing integrated to [WebdriverIO](https://webdriver.io/) testing framework. diff --git a/packages/browser/README.md b/packages/browser/README.md index cb1afa98..620c05ab 100644 --- a/packages/browser/README.md +++ b/packages/browser/README.md @@ -1,10 +1,13 @@

- Argos + + + Argos +

-_Argos is a visual testing solution that fits in your workflow to avoid visual regression. Takes screenshots on each commit and be notified if something changes._ +

The open source visual testing plaform for modern engineering teams.

# Argos Browser diff --git a/packages/cli/README.md b/packages/cli/README.md index 91fd2306..2903669a 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -1,10 +1,13 @@

- Argos + + + Argos +

-_Argos is a visual testing solution that fits in your workflow to avoid visual regression. Takes screenshots on each commit and be notified if something changes._ +

The open source visual testing plaform for modern engineering teams.

# Argos Command Line Interface diff --git a/packages/core/README.md b/packages/core/README.md index ec3fdfa0..d71725b3 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -1,10 +1,13 @@

- Argos + + + Argos +

-_Argos is a visual testing solution that fits in your workflow to avoid visual regression. Takes screenshots on each commit and be notified if something changes._ +

The open source visual testing plaform for modern engineering teams.

# Argos JavaScript SDK Core diff --git a/packages/playwright/README.md b/packages/playwright/README.md index 1001dd95..22d213e2 100644 --- a/packages/playwright/README.md +++ b/packages/playwright/README.md @@ -1,10 +1,13 @@

- Argos + + + Argos +

-_Argos is a visual testing solution that fits in your workflow to avoid visual regression. Takes screenshots on each commit and be notified if something changes._ +

The open source visual testing plaform for modern engineering teams.

# Official Argos Playwright integration diff --git a/packages/storybook/README.md b/packages/storybook/README.md index bee36e30..6da9f744 100644 --- a/packages/storybook/README.md +++ b/packages/storybook/README.md @@ -1,10 +1,13 @@

- Argos + + + Argos +

-_Argos is a visual testing solution that fits in your workflow to avoid visual regression. Takes screenshots on each commit and be notified if something changes._ +

The open source visual testing plaform for modern engineering teams.

# Official Argos Storybook integration diff --git a/packages/util/README.md b/packages/util/README.md index 2420a260..374308d3 100644 --- a/packages/util/README.md +++ b/packages/util/README.md @@ -1,10 +1,13 @@

- Argos + + + Argos +

-_Argos is a visual testing solution that fits in your workflow to avoid visual regression. Takes screenshots on each commit and be notified if something changes._ +

The open source visual testing plaform for modern engineering teams.

# Argos Utilities