ariawalk 0.0.0-stage → 0.1.0

package/README.md

@@ -1,3 +1,18 @@
-# Temporary Holding Version
+# ariawalk
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Run [Ariawalk](https://ariawalk.com) accessibility tests with the browser on your own machine: against `localhost`, a staging site behind a VPN, or a preview deployment in CI. An AI agent tries your test's task the way a blind NVDA user would. The browser runs here; the agent's decisions, the review and the report stay in Ariawalk.
+
+```sh
+npx ariawalk install                     # once: the Chromium the CLI drives
+npx ariawalk login                       # confirm a code in your browser
+npx ariawalk run <testId> --base-url http://localhost:3000
+```
+
+`ariawalk login` shows a code and opens ariawalk.com/device, where you confirm it while signed in. That works over SSH too: open the link on any device. The CLI then gets an API key named "CLI · <your machine>" for the organization you pick (`--org` when you're in several), which you can revoke under **API and MCP** or with `ariawalk logout`. `ariawalk whoami` shows who you're logged in as. In CI, set `ARIAWALK_API_KEY` instead.
+
+- `--base-url` moves the test's start URL to another origin. Localhost and private hosts need no domain verification; public hosts must be verified in Ariawalk.
+- Secret test data values are never sent to the CLI. Pass them with `--data password=…` or `ARIAWALK_DATA_PASSWORD`.
+- Runs from your machine land in your own "local" environment, and runs in CI (GitHub Actions, GitLab, Buildkite) land in `ci:<branch>`. They never become the baseline for production runs.
+- Exit codes: `0` completed, `1` the site blocked the task, `2` the run failed (setup, quota, key).
+
+Every run counts toward your monthly runs. Screenshots stay on your machine; step transcripts, findings and page snapshots are uploaded for the report.