From a30c10f8342b4ce61048c25fd32409d036189bd3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Simon=20Andr=C3=A9?= <smn.andre@gmail.com>
Date: Tue, 4 Aug 2026 21:47:30 +0200
Subject: [PATCH] Rewrite the README

---
 README.md | 79 ++++++++++++++++++++++++++++++++++++++++++++++---------
 1 file changed, 66 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index 1eadac0..8a6e2fe 100644
--- a/README.md
+++ b/README.md
@@ -9,63 +9,106 @@
 
 # Setup Playwright (for PHP)
 
-Sets up the runner for [Playwright for PHP](https://playwright-php.dev):
-- install Playwright library globally
-- download the browser binaries (default: Chrome)
+Install the Playwright npm package and browser binaries for a
+[Playwright PHP](https://playwright-php.dev) GitHub Actions workflow.
 
-## Usage
+This action does not install PHP, Composer dependencies, or Playwright PHP.
+Configure those separately in your workflow.
+
+## Quick start
 
 ```yaml
 # .github/workflows/test.yml
 name: PHP Tests
-on: [push]
+
+on:
+  push:
+  pull_request:
+
 jobs:
   test:
     runs-on: ubuntu-latest
+
     steps:
       - uses: actions/checkout@v4
 
-      - uses: playwright-php/setup-playwright@v1
-        with:
-          browsers: chrome      # default value
-          
       - uses: shivammathur/setup-php@v2
         with:
           php-version: '8.4'
+
+      - uses: playwright-php/setup-playwright@v1
+        with:
+          playwright-version: '1.58.2'
+          browsers: chromium
+
       - run: composer install
       - run: vendor/bin/phpunit
 ```
 
+Pin `playwright-version` to the version expected by Playwright PHP so CI does
+not change when Playwright publishes a new release.
+
 ## Examples
 
 ### Install multiple browsers
+
 ```yaml
 - uses: playwright-php/setup-playwright@v1
   with:
     browsers: '["chromium","firefox"]'
 ```
 
+Use `chromium` for Playwright's bundled open-source browser. Use `chrome` when
+the workflow specifically needs the Google Chrome channel.
+
 ### Reuse cached browser downloads
+
 ```yaml
+- name: Choose Playwright version
+  run: echo "PLAYWRIGHT_VERSION=1.58.2" >> "$GITHUB_ENV"
+
 - uses: actions/cache@v4
   with:
     path: ~/.cache/ms-playwright
-    key: browsers-${{ runner.os }}
+    key: playwright-${{ runner.os }}-${{ env.PLAYWRIGHT_VERSION }}-chromium
 
 - uses: playwright-php/setup-playwright@v1
   with:
+    playwright-version: ${{ env.PLAYWRIGHT_VERSION }}
+    browsers: chromium
     browsers-path: ~/.cache/ms-playwright
 ```
 
-### Pin the Playwright CLI version and skip deps
+Include the runner OS, Playwright version, and browser selection in the cache
+key. Browser binaries are tied to their Playwright release.
+
+### Use the action outputs
+
+```yaml
+- id: playwright
+  uses: playwright-php/setup-playwright@v1
+  with:
+    playwright-version: '1.58.2'
+    browsers: '["chromium","firefox"]'
+
+- name: Show installed runtime
+  run: |
+    echo "Playwright ${{ steps.playwright.outputs.playwright-version }}"
+    echo '${{ steps.playwright.outputs.installed-browsers }}'
+```
+
+### Control operating-system dependencies
+
 ```yaml
 - uses: playwright-php/setup-playwright@v1
   with:
-    playwright-version: '1.48.2'
     browsers: webkit
     with-deps: false
 ```
 
+`with-deps: auto` installs browser system dependencies on Linux and skips that
+step on macOS and Windows. Use `true` or `false` to override this behavior.
+
 ## Outputs
 
 The action exposes two outputs:
@@ -78,10 +121,20 @@ The action exposes two outputs:
 | Option               | Default  | Allowed values                                             | Notes                                                                                                                                                                    |
 |----------------------|----------|------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | `browsers`           | `chrome` | `chrome`, `chromium`, `firefox`, `webkit`, `msedge`, `all` | `msedge` only on Windows runners                                                                                                                                         |
-| `playwright-version` | `latest` | Any valid npm specifier (for the `playwright` package)     | Leave `latest` to track upstream.                                                                                                                                        |
+| `playwright-version` | `latest` | Any valid npm specifier (for the `playwright` package)     | Pin an exact version for reproducible CI. Use `latest` only when intentionally testing new upstream releases.                                                            |
 | `with-deps`          | `auto`   | `true`, `false`, `auto`                                    | `auto` appends Playwright's `--with-deps` flag on Linux runners.                                                                                                         |
 | `browsers-path`      |          | Directory path                                             | Exports `PLAYWRIGHT_BROWSERS_PATH` so downloads land in your cache. Leave blank for Playwright defaults (`~/.cache/ms-playwright`, `%LOCALAPPDATA%\ms-playwright`, etc.) |
 
+## Action version
+
+Reference `playwright-php/setup-playwright@v1` to receive backward-compatible
+fixes within the current major version. Pin a complete tag such as `@v1.0.0`
+when the workflow must use an immutable action revision.
+
+The action version and the `playwright-version` input are independent: the
+first selects the action code, the second selects the npm package and browser
+binaries the action installs.
+
 ## Testing the action
 
 1. Trigger `.github/workflows/test.yml` via `workflow_dispatch` to exercise the action on hosted runners.