Update Readme

Author: cubahno

.github/workflows/mockzilla.yml

@@ -13,7 +13,9 @@ permissions:
 jobs:
   publish:
     runs-on: ubuntu-latest
-    if: contains(github.event.pull_request.labels.*.name, 'Mockzilla')
+    if: >-
+      github.event_name == 'push' ||
+      contains(github.event.pull_request.labels.*.name, 'Mockzilla')
     steps:
       - uses: actions/checkout@v4
 

README.md

@@ -84,3 +84,48 @@ make build
 ```
 
 See the [Connexions docs](https://github.com/mockzilla/connexions) for more options.
+
+## Release
+
+Every push to main/master generates code, builds binaries for Linux, macOS, and Windows (amd64 and arm64), 
+and publishes them to the **Releases** page. 
+Download the binary for your platform from the `latest` release and run it locally:
+
+```bash
+./your-repo-name
+```
+
+## Mockzilla workflow
+
+The included GitHub Actions workflow (`.github/workflows/mockzilla.yml`) publishes your server to [Mockzilla](https://mockzilla.org) automatically:
+
+- **Push to main/master** — builds and publishes the server to your main simulation
+- **Pull request with `Mockzilla` label** — deploys a preview simulation for the PR (torn down when the PR is closed)
+
+The `Mockzilla` label is created automatically on first push via the setup workflow.
+
+Your simulation will be available at:
+- `https://api.mockzilla.org/gh/{org}/{repo}/` — main branch
+- `https://api.mockzilla.org/gh/{org}/{repo}/pr-{n}/` — per pull request
+
+### Action inputs
+
+You can customize the action in `.github/workflows/mockzilla.yml`:
+
+```yaml
+- uses: mockzilla/actions/codegen@v1
+  with:
+    token: ${{ secrets.GITHUB_TOKEN }}
+    region: us-east-1        # optional — preferred AWS region, used as a hint on first deploy only
+    memory: 128              # optional — memory in MB (e.g. 128, 256, 512)
+    timeout: 10000           # optional — request timeout in milliseconds
+    timeout-minutes: 5       # optional — max minutes to wait for simulation to become active (default: 5)
+```
+
+| Input | Required | Description |
+|---|---|---|
+| `token` | yes | `GITHUB_TOKEN` — used to verify repo identity |
+| `region` | no | Preferred AWS region (e.g. `us-east-1`, `ap-southeast-1`). Used as a hint on first deploy — if at capacity, the nearest available region is used. Has no effect after the simulation is deployed. |
+| `memory` | no | Memory in megabytes (e.g. `128`, `256`, `512`). |
+| `timeout` | no | Request timeout for the simulation in milliseconds. |
+| `timeout-minutes` | no | Max minutes the action polls for the simulation to become active. Defaults to `5`. |