docs: make README default to English

SivanCola · SivanCola · commit 038b00465dfd · 2026-04-28T19:04:52.000+08:00
diff --git a/README.md b/README.md
@@ -1,45 +1,56 @@
-# JumpProto
+<div align="center">
+  <h1>JumpProto</h1>
 
-在 Go 与 `.proto` 之间极速双向跳转，支持定义级与元素级精确定位。  
-从“看定义”到“改完即编译”，在一个面板里完成。
+  <p><strong>Fast Go and .proto navigation for VS Code, with symbol-level jumps and an integrated proto compile workflow.</strong></p>
 
----
+  <p>
+    <a href="https://marketplace.visualstudio.com/items?itemName=SivanLiu.jumpproto"><img alt="version" src="https://img.shields.io/visual-studio-marketplace/v/SivanLiu.jumpproto?label=version"></a>
+    <img alt="platform" src="https://img.shields.io/badge/platform-VS%20Code-007ACC">
+    <img alt="built with" src="https://img.shields.io/badge/built%20with-TypeScript-3178C6">
+    <img alt="license" src="https://img.shields.io/badge/license-Apache--2.0-2D7D46">
+    <img alt="downloads" src="https://img.shields.io/visual-studio-marketplace/d/SivanLiu.jumpproto?label=downloads">
+  </p>
 
-## 中文说明
+  <p>
+    English | <a href="#zh-cn">中文</a> | <a href="CHANGELOG.md">Changelog</a>
+  </p>
+</div>
 
-### 为什么选 JumpProto
+---
 
-- 双向导航：`Go -> .proto`、`.proto -> Go` 一键互跳
-- 精确到元素：支持 `message / enum / service / rpc`，并可定位字段和内部元素
-- 操作路径短：`F12`、`Ctrl/Cmd + Click`、右键菜单、状态栏、侧边栏都可触发
-- 兼容现有工程：基于生成文件头部 `// source: path/to/file.proto` 自动回溯源码
-- 直接集成编译：支持在侧边栏配置并执行 `make proto` 规则模板
+## Why JumpProto
 
-### 典型使用场景
+- Bi-directional navigation: `Go -> .proto` and `.proto -> Go`
+- Symbol-level precision for `message / enum / service / rpc`, fields, and nested symbols
+- Short action paths from `F12`, `Ctrl/Cmd + Click`, context menu, status bar, and sidebar
+- Resolves source `.proto` files from generated Go headers like `// source: path/to/file.proto`
+- Built-in proto compile workflow from the sidebar using a command template
 
-- 在 Go 与 Proto 之间快速来回追踪定义关系
-- 排查字段变更、枚举值和 RPC 接口影响范围
-- 多目录 proto 仓库中减少全文搜索与手动切换
+## Common Use Cases
 
-### 30 秒上手
+- Jump back and forth between generated Go code and source Proto definitions
+- Trace field changes, enum values, and RPC interface impact quickly
+- Reduce manual search and file switching in multi-directory proto repositories
 
-1. 在 VS Code 安装 `JumpProto`
-2. 打开包含 `.pb.go` 的 Go 工程
-3. 配置 `protoJump.protoRoots`（推荐）
-4. 将光标放在目标符号上并按 `F12`
+## Quick Start
 
-### 核心功能入口
+1. Install `JumpProto` from the VS Code Marketplace.
+2. Open a Go project with generated `.pb.go` files.
+3. Configure `protoJump.protoRoots` if your source proto files live outside the current workspace.
+4. Put the cursor on a target symbol and press `F12`.
+
+## Main Commands
 
 - `JumpProto: Go to Proto Definition`
 - `JumpProto: Go to Go Usage`
 - `JumpProto: Compile Current Proto`
-- 侧边栏 `?`：打开 Make Proto 规则说明
+- Sidebar `?`: open Make Proto rule guide
 
-### 配置项
+## Settings
 
-#### `protoJump.protoRoots`
+### `protoJump.protoRoots`
 
-`.proto` 源文件根目录列表（可多个）。
+List of source `.proto` roots. Multiple directories are supported.
 
 ```json
 {
@@ -50,31 +61,25 @@
 }
 ```
 
-#### `protoJump.searchInWorkspace`
-
-- 类型：`boolean`
-- 默认：`true`
-- 说明：当 `protoRoots` 未命中时，是否继续在当前工作区内搜索
+### `protoJump.searchInWorkspace`
 
-#### `protoJump.makeProtoCommand`
-
-- 类型：`string`
-- 默认：`""`（空）
-- 说明：用于“编译当前 Proto”的命令模板，运行时会按当前 `.proto` 上下文替换占位符
+- Type: `boolean`
+- Default: `true`
+- Description: continue searching in the current workspace when `protoRoots` has no match
 
-快速流程：
+### `protoJump.makeProtoCommand`
 
-1. 在侧边栏填写规则并保存
-2. 点击“测试命令”（dry-run，仅校验模板与 shell 语法）
-3. 点击“编译当前 Proto”执行真实命令
+- Type: `string`
+- Default: `""`
+- Description: shell template for `Compile Current Proto`; placeholders are resolved from the active `.proto` context
 
-示例模板：
+Example:
 
 ```bash
 cd {protoSrcRoot} && make special_proto packagename={protoPackage} filename={protoFileNoExt}
 ```
 
-可用占位符：
+Supported placeholders:
 
 - `{workspaceFolder}`
 - `{protoSrcRoot}`
@@ -85,66 +90,75 @@ cd {protoSrcRoot} && make special_proto packagename={protoPackage} filename={pro
 - `{relativeProtoNoExt}`
 - `{protoPackage}`
 
-#### `protoJump.uiLanguage`
+### `protoJump.uiLanguage`
 
-- 类型：`"zh" | "en"`
-- 默认：`"en"`
-- 说明：控制侧边栏与提示消息语言
+- Type: `"zh" | "en"`
+- Default: `"en"`
+- Description: language for sidebar and notifications
 
-### 前置条件
+## Requirements
 
-- 项目使用 `protoc-gen-go` 生成 `.pb.go`
-- 生成文件头部包含：
+- `.pb.go` files are generated by `protoc-gen-go`
+- Generated file headers include:
 
 ```go
 // source: path/to/file.proto
 ```
 
-### 常见问题
+## FAQ
 
-#### 为什么会出现多个定义候选？
+### Why do multiple definition candidates appear?
 
-启用 `gopls` 时，VS Code 可能同时给出 `.pb.go` 与 `.proto` 候选。选择 `.proto` 即可。
+When `gopls` is enabled, VS Code may show both `.pb.go` and `.proto` definition candidates. Choose the `.proto` candidate.
 
-#### 找不到目标 proto 文件怎么办？
+### What if JumpProto cannot find the target proto file?
 
-- 检查 `protoJump.protoRoots` 是否正确
-- 检查 `.pb.go` 中 `// source:` 路径是否与仓库结构一致
-- 检查 `protoJump.searchInWorkspace` 是否被关闭
+- Check that `protoJump.protoRoots` is configured correctly.
+- Check that the `// source:` path in `.pb.go` matches your repository structure.
+- Check whether `protoJump.searchInWorkspace` has been disabled.
 
 ---
 
-## English
+<a id="zh-cn"></a>
 
-JumpProto gives you fast, precise, bi-directional navigation between Go and `.proto`, plus an integrated proto compile flow.
+## 中文说明
+
+在 Go 与 `.proto` 之间极速双向跳转，支持定义级与元素级精确定位。<br>
+从“看定义”到“改完即编译”，在一个面板里完成。
 
-### Why JumpProto
+### 为什么选 JumpProto
 
-- Bi-directional jumps: `Go -> .proto` and `.proto -> Go`
-- Element-level precision for `message / enum / service / rpc`, fields, and nested symbols
-- Multiple entry points: `F12`, `Ctrl/Cmd + Click`, context menu, status bar, sidebar
-- Works with generated Go files via `// source: path/to/file.proto`
-- Built-in compile workflow from sidebar using a command template
+- 双向导航：`Go -> .proto`、`.proto -> Go` 一键互跳
+- 精确到元素：支持 `message / enum / service / rpc`，并可定位字段和内部元素
+- 操作路径短：`F12`、`Ctrl/Cmd + Click`、右键菜单、状态栏、侧边栏都可触发
+- 兼容现有工程：基于生成文件头部 `// source: path/to/file.proto` 自动回溯源码
+- 直接集成编译：支持在侧边栏配置并执行 `make proto` 规则模板
 
-### Quick Start
+### 典型使用场景
 
-1. Install `JumpProto` from VS Code Marketplace
-2. Open a Go project with generated `.pb.go` files
-3. Configure `protoJump.protoRoots` (recommended)
-4. Put cursor on a symbol and press `F12`
+- 在 Go 与 Proto 之间快速来回追踪定义关系
+- 排查字段变更、枚举值和 RPC 接口影响范围
+- 多目录 proto 仓库中减少全文搜索与手动切换
 
-### Main Commands
+### 30 秒上手
+
+1. 在 VS Code 安装 `JumpProto`
+2. 打开包含 `.pb.go` 的 Go 工程
+3. 配置 `protoJump.protoRoots`（推荐）
+4. 将光标放在目标符号上并按 `F12`
+
+### 核心功能入口
 
 - `JumpProto: Go to Proto Definition`
 - `JumpProto: Go to Go Usage`
 - `JumpProto: Compile Current Proto`
-- Sidebar `?`: open Make Proto rule guide
+- 侧边栏 `?`：打开 Make Proto 规则说明
 
-### Settings
+### 配置项
 
 #### `protoJump.protoRoots`
 
-List of source `.proto` roots.
+`.proto` 源文件根目录列表（可多个）。
 
 ```json
 {
@@ -157,23 +171,23 @@ List of source `.proto` roots.
 
 #### `protoJump.searchInWorkspace`
 
-- Type: `boolean`
-- Default: `true`
-- Description: continue searching in workspace when `protoRoots` has no match
+- 类型：`boolean`
+- 默认：`true`
+- 说明：当 `protoRoots` 未命中时，是否继续在当前工作区内搜索
 
 #### `protoJump.makeProtoCommand`
 
-- Type: `string`
-- Default: `""`
-- Description: shell template for `Compile Current Proto`; placeholders are resolved from active `.proto` context
+- 类型：`string`
+- 默认：`""`（空）
+- 说明：用于“编译当前 Proto”的命令模板，运行时会按当前 `.proto` 上下文替换占位符
 
-Example:
+示例模板：
 
 ```bash
 cd {protoSrcRoot} && make special_proto packagename={protoPackage} filename={protoFileNoExt}
 ```
 
-Supported placeholders:
+可用占位符：
 
 - `{workspaceFolder}`
 - `{protoSrcRoot}`
@@ -186,32 +200,41 @@ Supported placeholders:
 
 #### `protoJump.uiLanguage`
 
-- Type: `"zh" | "en"`
-- Default: `"en"`
-- Description: language for sidebar and notifications
+- 类型：`"zh" | "en"`
+- 默认：`"en"`
+- 说明：控制侧边栏与提示消息语言
 
-### Requirements
+### 前置条件
 
-- `.pb.go` is generated by `protoc-gen-go`
-- Generated file header includes:
+- 项目使用 `protoc-gen-go` 生成 `.pb.go`
+- 生成文件头部包含：
 
 ```go
 // source: path/to/file.proto
 ```
 
----
+### 常见问题
+
+#### 为什么会出现多个定义候选？
+
+启用 `gopls` 时，VS Code 可能同时给出 `.pb.go` 与 `.proto` 候选。选择 `.proto` 即可。
 
-## 隐私说明 / Privacy
+#### 找不到目标 proto 文件怎么办？
+
+- 检查 `protoJump.protoRoots` 是否正确
+- 检查 `.pb.go` 中 `// source:` 路径是否与仓库结构一致
+- 检查 `protoJump.searchInWorkspace` 是否被关闭
+
+---
 
-文档示例统一使用占位路径（如 `/ABSOLUTE/PATH/TO/...`、`$HOME/...`），避免暴露个人目录信息。  
-All path examples use placeholders to avoid exposing personal local directory information.
+## Privacy
 
-## 开源协议 / License
+All path examples use placeholders such as `/ABSOLUTE/PATH/TO/...` and `$HOME/...` to avoid exposing personal local directory information.
 
-JumpProto 以 Apache License 2.0 开源，详见 [LICENSE](LICENSE)。第三方素材声明见 [NOTICE](NOTICE) 和 [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md)。
+## License
 
-JumpProto is licensed under the Apache License 2.0. Third-party asset notices are listed in [NOTICE](NOTICE) and [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).
+JumpProto is licensed under the Apache License 2.0. See [LICENSE](LICENSE). Third-party asset notices are listed in [NOTICE](NOTICE) and [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).
 
-## Bug 反馈 / Bug Reports
+## Bug Reports
 
-- 提交地址 / Report here: <https://github.com/SivanCola/issues/issues>
+- Report here: <https://github.com/SivanCola/issues/issues>
