From fe9e2604eb42dc20da5d05b575ba0808246cb7c2 Mon Sep 17 00:00:00 2001
From: Xi Xu <i@xi-xu.me>
Date: Sat, 11 Apr 2026 17:40:36 +0800
Subject: [PATCH] docs: add upstream link and prebuilt OCI image docs

---
 README.md    | 13 +++++++++++--
 README.zh.md | 13 +++++++++++--
 2 files changed, 22 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index f1b06c2..0441716 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@
 
 Self-hosted Paseo relay.
 
-This repository packages the upstream `@getpaseo/relay/cloudflare` adapter as a thin deployment wrapper. It does not implement a custom relay protocol, admin API, or auth layer. The runtime contract stays aligned with upstream Paseo while this repo owns deployment, validation, and operational packaging.
+This repository packages the upstream [`getpaseo/paseo`](https://github.com/getpaseo/paseo) `@getpaseo/relay/cloudflare` adapter as a thin deployment wrapper. It does not implement a custom relay protocol, admin API, or auth layer. The runtime contract stays aligned with upstream Paseo while this repo owns deployment, validation, and operational packaging.
 
 ## What This Repo Provides
 
@@ -66,6 +66,15 @@ bun run oci:run
 
 The OCI image exposes the relay on port `8080`.
 
+### Run the prebuilt OCI image
+
+Prebuilt images are published to GHCR:
+
+```bash
+docker pull ghcr.io/xixu-me/paseo-relay:main
+docker run --rm -p 8080:8080 -v paseo-relay-data:/var/lib/paseo-relay/do ghcr.io/xixu-me/paseo-relay:main
+```
+
 ## Cloudflare Deployment
 
 `wrangler.jsonc` is the source of truth for the Worker deployment:
@@ -143,7 +152,7 @@ OCI publishing uses the built-in `GITHUB_TOKEN`.
 
 ## OCI Notes
 
-The image is built from the Worker bundle generated by Wrangler and served by `workerd`. The runtime image:
+The image is built from the Worker bundle generated by Wrangler and served by `workerd`. Prebuilt images are published as `ghcr.io/xixu-me/paseo-relay:main`. The runtime image:
 
 - listens on `:8080`
 - persists Durable Object state under `/var/lib/paseo-relay/do`
diff --git a/README.zh.md b/README.zh.md
index 74bd85b..799dd00 100644
--- a/README.zh.md
+++ b/README.zh.md
@@ -4,7 +4,7 @@
 
 自托管的 Paseo relay。
 
-该存储库将上游 `@getpaseo/relay/cloudflare` 适配器封装为一个轻量部署包装层。它不实现自定义 relay 协议、管理 API 或认证层。运行时契约与上游 Paseo 保持一致，而该存储库负责部署、校验和运维打包。
+该存储库将上游 [`getpaseo/paseo`](https://github.com/getpaseo/paseo) 的 `@getpaseo/relay/cloudflare` 适配器封装为一个轻量部署包装层。它不实现自定义 relay 协议、管理 API 或认证层。运行时契约与上游 Paseo 保持一致，而该存储库负责部署、校验和运维打包。
 
 ## 此存储库提供的内容
 
@@ -66,6 +66,15 @@ bun run oci:run
 
 OCI 镜像会在 `8080` 端口暴露 relay。
 
+### 运行预构建 OCI 镜像
+
+预构建镜像会发布到 GHCR：
+
+```bash
+docker pull ghcr.io/xixu-me/paseo-relay:main
+docker run --rm -p 8080:8080 -v paseo-relay-data:/var/lib/paseo-relay/do ghcr.io/xixu-me/paseo-relay:main
+```
+
 ## Cloudflare 部署
 
 `wrangler.jsonc` 是 Worker 部署的单一事实来源：
@@ -143,7 +152,7 @@ OCI 发布使用内置的 `GITHUB_TOKEN`。
 
 ## OCI 说明
 
-镜像基于 Wrangler 生成的 Worker bundle 构建，并由 `workerd` 提供服务。运行时镜像：
+镜像基于 Wrangler 生成的 Worker bundle 构建，并由 `workerd` 提供服务。预构建镜像会发布为 `ghcr.io/xixu-me/paseo-relay:main`。运行时镜像：
 
 - 监听 `:8080`
 - 将 Durable Object 状态持久化到 `/var/lib/paseo-relay/do`