From 15e81cbcb6d8fa570fa71615f98b914568571d7f Mon Sep 17 00:00:00 2001 From: fancivez Date: Wed, 29 Apr 2026 18:16:43 +0800 Subject: [PATCH] docs: expand readme badges and language switcher Change-Id: Ia547e146cca71f0daf04c896fd14f892940ed707 --- README.md | 43 +++++++++++++++++++++++++++++++++++-------- README.zh-CN.md | 41 +++++++++++++++++++++++++++++++++-------- 2 files changed, 68 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 3d35732..8a7c862 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,31 @@ +

Obsidian Parallel Reader

+

- Release - CI - License - Stars + Split-view reading for Obsidian — your original note on the left, AI-generated summary cards on the right, with scroll-sync highlighting.

-# Obsidian Parallel Reader +

+ Latest release + Total downloads + CI status + License + Obsidian 1.4+ +

-> **[中文文档](./README.zh-CN.md)** +

+ Stars + Open issues + Last commit + TypeScript strict + Code style: Biome + 中文文档 +

-Split-view reading for Obsidian — your original note on the left, AI-generated summary cards on the right, with scroll-sync highlighting. +

+ English · 中文 +

+ +--- Inspired by [this reading workflow demo](https://www.bilibili.com/video/BV1FxoGBVETm/). @@ -109,9 +125,14 @@ npm run build # production build npm run typecheck # TypeScript strict mode npm run lint # Biome npm test # build + typecheck + tests +npm run test:unit +npm run test:component +npm run test:contract +npm run test:e2e # packaged plugin + disposable Vault smoke ``` -The project also has a host-neutral e2e contract gate: +The project also has a host-neutral e2e contract gate for product-shell smoke +evidence: ```bash bash .e2e/gate.sh --json @@ -119,6 +140,12 @@ bash .e2e/gate.sh --json If `e2e_contract_validator` is not installed, set `E2E_CONTRACT_VALIDATOR_PYTHONPATH` to the `claude-code-addons/scripts` directory before running the gate. Runtime evidence such as `.e2e/artifact.json` and `.e2e/results/` is generated locally and ignored by git. +Test classification lives in `tests/catalog.json`. `verify` owns unit, +component, contract, and local integration checks. Mocked Obsidian/runtime tests +are classified as component or contract tests, not product e2e. The `.e2e` gate +intentionally includes only the default product-shell smoke plus optional live +local Vault/provider checks with `TEST_LIVE=1`. + ## Star History diff --git a/README.zh-CN.md b/README.zh-CN.md index 7a3d0a6..429570d 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -1,15 +1,31 @@ +

Obsidian Parallel Reader

+

- Release - CI - License - Stars + Obsidian 对照阅读插件 — 左边原文、右边 AI 摘要卡片，滚动联动、点击跳转。

-# Obsidian Parallel Reader +

+ 最新版本 + 累计下载 + CI 状态 + 开源协议 + Obsidian 1.4+ +

-> **[English](./README.md)** +

+ Star 数 + 未关闭 issue + 最近提交 + TypeScript strict + 代码风格 Biome + English README +

-Obsidian 对照阅读插件 — 左边原文、右边 AI 摘要卡片，滚动联动、点击跳转。 +

+ English · 中文 +

+ +--- 灵感来自 [这个 B 站视频](https://www.bilibili.com/video/BV1FxoGBVETm/) 的阅读工作流演示。 @@ -109,9 +125,13 @@ npm run build # 生产构建 npm run typecheck # TypeScript strict 模式 npm run lint # Biome npm test # 构建 + 类型检查 + 测试 +npm run test:unit +npm run test:component +npm run test:contract +npm run test:e2e # 打包插件 + 临时 Vault smoke ``` -项目还提供一个与宿主环境解耦的 e2e contract gate： +项目还提供一个与宿主环境解耦的 e2e contract gate，用于产品壳 smoke 证据： ```bash bash .e2e/gate.sh --json @@ -119,6 +139,11 @@ bash .e2e/gate.sh --json 如果本机没有安装 `e2e_contract_validator`，运行前把 `E2E_CONTRACT_VALIDATOR_PYTHONPATH` 指向 `claude-code-addons/scripts` 目录。`.e2e/artifact.json`、`.e2e/results/` 等运行证据只在本地生成，并已被 git 忽略。 +测试分类的来源是 `tests/catalog.json`。`verify` 负责 unit、component、contract +和本地 integration 检查。使用 mock Obsidian/runtime 的测试归为 component 或 +contract，不声明为产品 e2e。`.e2e` gate 只包含默认产品壳 smoke，以及通过 +`TEST_LIVE=1` 显式开启的真实本地 Vault/provider 检查。 + ## Star History