From aa4d8fe4b6e1ed3184ca1c888024004b3f1842a2 Mon Sep 17 00:00:00 2001
From: Elijah Zupancic <elijah@zupancic.name>
Date: Sat, 25 Jul 2026 11:43:57 -0700
Subject: [PATCH] docs(readme): surface live example report links

The self-scan reports are the fastest way for a new reader to see
what bca actually produces, but the README rewrite in ec8184c2 folded
the top-level "Live example reports" section into the CI section,
leaving the links roughly a hundred lines down the page.

Add a labelled link pair (HTML hotspot report, Markdown report)
directly after the feature bullets in both READMEs, above the fold.
The CI section keeps its copy of the URLs, where they document what
the pages workflow publishes. The Japanese README marks the pair as
English-only, since the reports are published at /reports/ rather
than under /ja/.
---
 README.ja.md | 8 ++++++++
 README.md    | 9 +++++++++
 2 files changed, 17 insertions(+)

diff --git a/README.ja.md b/README.ja.md
index 9cc7d5aa..fc89fa51 100644
--- a/README.ja.md
+++ b/README.ja.md
@@ -32,6 +32,14 @@
 - ライブラリバインディング — 同じエンジンを Rust クレート、
   [Python パッケージ](https://pypi.org/project/big-code-analysis/)、REST サーバー（`bca-web`）として利用できます。
 
+インストール前に出力を確認したい場合は、`bca` が `main` へのプッシュのたびに
+自分自身のソースを解析して公開している結果をご覧ください。
+
+- [**HTML ホットスポットレポート（実例）**](https://dekobon.github.io/big-code-analysis/reports/index.html)
+  — ファイル単位・関数単位でブラウズできるビュー（英語）。
+- [**Markdown レポート（実例）**](https://dekobon.github.io/big-code-analysis/reports/report.md)
+  — 同じ実行結果をプルリクエストのコメント形式にしたもの（英語）。
+
 完全なドキュメントは[**ドキュメントブック（日本語版）**](https://dekobon.github.io/big-code-analysis/ja/)にあります。
 メトリクスの定義、コマンドリファレンス、CI レシピ、ライブラリガイドを収録しています。
 
diff --git a/README.md b/README.md
index d28ad52f..f4c02ffb 100644
--- a/README.md
+++ b/README.md
@@ -42,6 +42,15 @@ that grows the metric engine into a code-quality toolchain:
   [Python package](https://pypi.org/project/big-code-analysis/), and a
   REST server (`bca-web`).
 
+`bca` analyses its own source on every push to `main` and publishes
+the result, so you can see what a real run looks like before
+installing anything:
+
+- [**Live HTML hotspot report**](https://dekobon.github.io/big-code-analysis/reports/index.html)
+  — the browsable per-file, per-function view.
+- [**Live Markdown report**](https://dekobon.github.io/big-code-analysis/reports/report.md)
+  — the same run as a pull-request comment.
+
 The full documentation lives in
 [**the book**](https://dekobon.github.io/big-code-analysis/): metrics
 definitions, command reference, CI recipes, and library guides.