diff --git a/README.md b/README.md index 443bcf1..ae45d98 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,21 @@ # sanderling -Autonomous property-based testing for mobile apps. Specs in TypeScript. Core in Go. Drives the app under test through Maestro. +Autonomous property-based testing for mobile and web apps. Specs in TypeScript. Core in Go. Drives native apps through Maestro (UIAutomator / XCTest) and the web through the Chrome DevTools Protocol. -> Alpha. Android emulator only. Full scope in the [v0.1.0 roadmap](https://github.com/priyanshujain/sanderling/issues/4). +> Alpha. Android, iOS, and web (Chrome). Full scope in the [v0.1.0 roadmap](https://github.com/priyanshujain/sanderling/issues/4). ## Docs - [Getting started](https://priyanshujain.github.io/sanderling/manual/getting-started.html) - [Writing specs](https://priyanshujain.github.io/sanderling/manual/writing-specs.html) - [`sanderling inspect` UI](https://priyanshujain.github.io/sanderling/manual/inspect.html) -- [Example](https://github.com/priyanshujain/sanderling/tree/master/examples/folio) - [Architecture](https://priyanshujain.github.io/sanderling/development/architecture.html) +## Example apps + +- [`examples/folio`](https://github.com/priyanshujain/sanderling/tree/master/examples/folio) - Kotlin Multiplatform ledger app, runs on Android, iOS, and web (wasmJs). +- [`examples/folio-web`](https://github.com/priyanshujain/sanderling/tree/master/examples/folio-web) - React + Vite version of the same domain, web-only. + After a `sanderling test` run, browse traces locally with `sanderling inspect`. It opens a web UI for stepping through actions, screenshots, snapshots, residual formulas, and exceptions. ---