From 69a7fbe32e5f0cb91a57748c293dc4f698bae9ab Mon Sep 17 00:00:00 2001 From: Andrew Goldis Date: Sun, 5 Nov 2023 01:06:42 -0700 Subject: [PATCH] chore: update README --- README.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 0d4654a..99cd197 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,13 @@ # Currents.dev - CircleCI Playwright Example -This is an example repository that showcases using [CircleCI](https://circleci.com) with [Currents.dev](https://currents.dev). +This is an example repository that showcases running Playwright tests using 3 parallel [CircleCI](https://circleci.com) containers with [Currents.dev](https://currents.dev). -The example [config file](https://github.com/currents-dev/circleci-example/blob/master/.circleci/config.yml): +The example [config file](.circleci/config.yml): - uses [Test CLI commands](https://playwright.dev/docs/test-cli) to run `@currents/playwright` for recording test results and parallelization with [Currents.dev](https://currents.dev) -- Note: set the `CURRENTS_PROJECT_ID` [Environment variable](https://circleci.com/docs/2.0/env-vars/) - obtain the project id from [Currents.dev](https://app.currents.dev) +- Set the `CURRENTS_PROJECT_ID` [Environment variable](https://circleci.com/docs/2.0/env-vars/) - obtain the project id from [Currents.dev](https://app.currents.dev) -- Note: use CLI arguments to customize your Playwright runs, e.g.: `pwc --key ` +- Use CLI arguments to customize your Playwright runs, e.g.: `npx pwc --key ` -- Note: create an organization, get your record key at [Currents.dev](https://app.currents.dev) and set [Environment variable](https://circleci.com/docs/2.0/env-vars/) `CURRENTS_RECORD_KEY` - ---- \ No newline at end of file +- Create an organization, get your record key at [Currents.dev](https://app.currents.dev) and set [Environment variable](https://circleci.com/docs/2.0/env-vars/) `CURRENTS_RECORD_KEY`