From 92c9e89008a02ba2164b9e56c2f9e7422b77e3c8 Mon Sep 17 00:00:00 2001 From: PJ Date: Fri, 15 May 2026 14:39:53 +0530 Subject: [PATCH] docs: tighten README, fold examples into Docs list --- README.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ae45d98..1a38e7d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # sanderling -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. +Autonomous property-based testing for mobile and web apps. Specs in TypeScript. Core in Go. Drives native apps through Maestro and the web through the Chrome DevTools Protocol. > Alpha. Android, iOS, and web (Chrome). Full scope in the [v0.1.0 roadmap](https://github.com/priyanshujain/sanderling/issues/4). @@ -9,13 +9,9 @@ Autonomous property-based testing for mobile and web apps. Specs in TypeScript. - [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) +- Examples: [folio](https://github.com/priyanshujain/sanderling/tree/master/examples/folio) (KMP, Android/iOS/web), [folio-web](https://github.com/priyanshujain/sanderling/tree/master/examples/folio-web) (React + Vite) - [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. ---