@stablyai/playwright-test 2.0.0 → 2.0.1

package/README.md

@@ -1,22 +1,69 @@
+<p align="center">
+  <a href="https://stably.ai">
+    <h3 align="center">Stably</h3>
+  </a>
+</p>
+
+<p align="center">
+  Code. Ship. <s>Test.</s>
+</p>
+
+<p align="center">
+  <a href="https://docs.stably.ai/"><strong>Documentation</strong></a> ·
+  <a href="https://stably.ai/"><strong>Homepage</strong></a>
+</p>
+<br/>
+
 # Stably Playwright Test
-This package extends Playwright to add new AI functionality
+
+This package extends Playwright to add new AI functionality.
+To get started quickly, please see [AI-assisted setup guide](https://docs.stably.ai/getting-started/sdk-setup-guide). Otherwise continue to read below.
 
 ## Installation
-First ensure you remove any previous playwright/playwright-test installation
-```shell
-npm remove playwright @playwright/test
-```
 
-Afterwards you can install Stably
+We assume you already have Playwright installed. If so you can run:
+
 ```shell
 npm install @stablyai/playwright-test
 ```
 
-## Setup
+## SDK
+
+### Setup
+
 Make sure you also get your [api-key](https://auth.stably.ai/account/api_keys) to use the AI features.
-Either set the `process.env.STABLY_API_KEY` variable or programtically call `setApiKey` from `"@stablyai/playwright-test"`
+Either set the `STABLY_API_KEY` environment variable or programtically call `setApiKey` from `"@stablyai/playwright-test"`
+
+### Usage
 
-## Usage
 1. Replace "@playwright/test" with "@stablyai/playwright-test"
    1. Ex: imports should look like: import { test, expect } from "@stablyai/playwright-test";
-2. Simply run tests with `npx playwright test` as you would normally using Playwright
+2. Simply run tests with `npx playwright test` as you would normally using Playwright
+
+### New Methods
+
+The SDK adds new methods with AI visual assertions, full agent mode, and text extraction. See our [docs](https://docs.stably.ai/stably-sdk/ai-assertions) for more information.
+
+## Stably Playwright Reporter
+
+The [Stably Playwright Reporter](https://docs.stably.ai/reports-analytics#reports-and-analytics) also comes bundled with this package. Most users will find value in using this reporter for recording test results and having AI diagnostics.
+
+### Setup
+
+First, ensure you have your `STABLY_API_KEY` (secret). If you don't have it, you can get it [here](https://auth.stably.ai/account/api_keys).
+Second, ensure that you have your Stably project ID (not a secret). You can get this from your web-app dashboard under settings
+
+In your `playwright.config.ts/js` file add:
+
+```typescript
+import { defineConfig } from '@playwright/test';
+import { stablyReporter } from '@stablyai/playwright-test';
+
+export default defineConfig({
+  ..., // your other config options go here
+  reporter: [
+    ..., // (optional) other reporters go here
+    stablyReporter({ apiKey: process.env.STABLY_API_KEY, projectId: 'abc123' }), // 👈 Stably Reporter
+  ]
+})
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stablyai/playwright-test",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Playwright Test wrapper with Stably AI matchers",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -21,8 +21,8 @@
     "dist"
   ],
   "dependencies": {
-    "@stablyai/playwright": "2.0.0",
-    "@stablyai/playwright-base": "2.0.0",
+    "@stablyai/playwright": "2.0.1",
+    "@stablyai/playwright-base": "2.0.1",
     "@stablyai/playwright-reporter": "1.3.1"
   },
   "peerDependencies": {