diff --git a/README.md b/README.md index 7757035..6b7c2b1 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,9 @@ [![TypeScript](https://img.shields.io/badge/TypeScript-5-blue)](https://www.typescriptlang.org/) [![Playwright](https://img.shields.io/badge/Playwright-ready-45ba4b)](https://playwright.dev/) -Shared Playwright and API test helpers for Levkin apps: resilient UI -actions, API client, timings, and metrics. +**Shared Playwright + API test helpers** — resilient UI actions, API client, timings, and metrics used across Levkin apps. -Public mirror: [github.com/Gitilia/playkit](https://github.com/Gitilia/playkit). -Issues welcome there; CI and publish run on the private forge. +> Public mirror: [github.com/Gitilia/playkit](https://github.com/Gitilia/playkit) · issues welcome here; CI/publish run on the private forge. ## Install (consumer) @@ -65,16 +63,16 @@ test('sign-out stays on public host', async ({ page, playkitConfig, timings }) = | `PLAYKIT_BASE_URL` / `BASE_URL` | yes | Public UI URL (e.g. `https://punimtagdev.levkin.ca`) | | `PLAYKIT_API_BASE_URL` | no | Defaults to base URL | | `PLAYKIT_EXPECTED_HOST` | no | Defaults to host of base URL | -| `PLAYKIT_FORBID_PRIVATE_HOSTS` | no | Default `true`, refuse `10.x` / localhost as expected host | +| `PLAYKIT_FORBID_PRIVATE_HOSTS` | no | Default `true` — refuse `10.x` / localhost as expected host | | `PLAYKIT_RETRY_PRESET` | no | `default` \| `strictCi` \| `flakyNetwork` (timeouts/retries) | | `PLAYKIT_ACTION_RETRIES` / `PLAYKIT_TIMEOUT_MS` | no | Override preset values | | `PLAYKIT_PROJECT` | no | Metric / log label | | `PLAYKIT_ENV` | no | Metric / log label (`dev`/`qa`/`prod`) | | `PLAYKIT_METRICS_ENABLED` | no | Push timings to Pushgateway | -| `PLAYKIT_PUSHGATEWAY_URL` | if metrics | e.g. `http://10.255.255.1:9091` | +| `PLAYKIT_PUSHGATEWAY_URL` | if metrics | e.g. `http://:9091` | | `PLAYKIT_LOG_LEVEL` | no | `debug` \| `info` \| `warn` \| `error` | -**Secrets:** put test credentials and pushgateway tokens in Infisical (`LevkinOps`) and sync into Gitea Actions, see ansible `docs/hardening/SECRETS.md`. Never commit passwords. +**Secrets:** put test credentials and pushgateway tokens in Infisical (`LevkinOps`) and sync into Gitea Actions — see ansible `docs/hardening/SECRETS.md`. Never commit passwords. ## What’s in the box @@ -118,7 +116,7 @@ try { ## Resilient UI automation (third-party / adversarial SPAs) `click`/`fill`/`waitForVisible` above assume you already have a correct -`Locator`, great when you control the markup and have stable test ids. These +`Locator` — great when you control the markup and have stable test ids. These helpers are for the opposite case: driving a third-party site you don't control, where selectors are dynamic/compound (aria-labels that embed record-specific text), rich-text fields aren't real `