From 13615c86a26ebfee1a70e88a85c83611000052ed Mon Sep 17 00:00:00 2001
From: openhands <openhands@all-hands.dev>
Date: Sat, 19 Jul 2025 16:31:30 +0000
Subject: [PATCH] Improve README.md documentation

- Add language annotations to code blocks
- Convert file references to clickable links
- Add quick start section for better user experience
- Add project structure overview
- Improve contribution guidelines with step-by-step instructions
- Add license section and enhanced acknowledgments
- Fix repository URL in clone instructions
- Make wording more friendly and welcoming
- Add internal navigation links
---
 README.md | 88 ++++++++++++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 77 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index eb70648..b0d5d91 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # Gemini for Claude Code: An Anthropic-Compatible Proxy
 
-[English Readme](./README.en.md)
+[English Readme](./README.en.md) | [CLAUDE.md 指令文件](./CLAUDE.md)
 
 这是一个 Claude Code 的代理服务器，旨在无缝桥接 Anthropic Messages API 与 Google Gemini API。它能够实时地将来自客户端（如 Claude Code）的 Anthropic API 格式请求，智能转换为 Gemini 模型所需的格式，并将 Gemini 的响应再转换回 Anthropic 格式。
 
@@ -10,6 +10,43 @@
 
 最终，这个项目充当了一个强大的 API 适配器，让开发者可以在不修改任何客户端代码的情况下，将为 Anthropic 生态系统构建的工具无缝对接到强大的 Gemini 模型上，极大地增强了技术选型的灵活性和互操作性。
 
+## 目录结构
+
+```
+claude_code_gemini_proxy/
+├── server.py              # 主服务器文件
+├── requirements.txt       # Python 依赖
+├── .env.example          # 环境变量示例
+├── CLAUDE.md             # Claude Code 指令文件
+├── README.md             # 中文说明文档
+├── README.en.md          # 英文说明文档
+└── image.png             # 示例图片
+```
+
+## 快速开始
+
+想要立即体验？只需几个简单步骤：
+
+1. **获取 API 密钥**：前往 [Google AI Studio](https://ai.google.dev/gemini-api/docs/api-key) 获取您的 Gemini API 密钥
+2. **克隆并配置**：
+   ```bash
+   git clone https://github.com/kele527/claude_code_gemini_proxy.git
+   cd claude_code_gemini_proxy
+   cp .env.example .env
+   # 编辑 .env 文件，添加您的 GEMINI_API_KEY
+   ```
+3. **安装并运行**：
+   ```bash
+   pip install -r requirements.txt
+   python server.py
+   ```
+4. **使用 Claude Code**：
+   ```bash
+   ANTHROPIC_BASE_URL=http://localhost:8082 claude
+   ```
+
+详细配置请参考下面的[安装与配置](#安装与配置)部分。
+
 ## 主要特性
 
 - **Claude Code 兼容性**: 让 Claude Code CLI 能直接使用 Google Gemini 模型。
@@ -23,17 +60,20 @@
 
 ## 环境准备
 
-- 一个 Google Gemini API 密钥。
-- Python 3.8+。
-- 已安装 Claude Code CLI (`npm install -g @anthropic-ai/claude-code`)。
+- 一个 [Google Gemini API 密钥](https://ai.google.dev/gemini-api/docs/api-key)
+- Python 3.8+
+- 已安装 Claude Code CLI：
+  ```bash
+  npm install -g @anthropic-ai/claude-code
+  ```
 
 ## 安装与配置
 
 1.  **克隆仓库**:
 
     ```bash
-    git clone https://github.com/kele527/claude-gemini-bridge.git # 或者你的 fork
-    cd claude-gemini-bridge
+    git clone https://github.com/kele527/claude_code_gemini_proxy.git # 或者你的 fork
+    cd claude_code_gemini_proxy
     ```
 
 2.  **创建并激活虚拟环境** (推荐):
@@ -56,9 +96,9 @@
     cp .env.example .env
     ```
 
-    编辑 `.env` 文件，填入您的 Gemini API 密钥，并可按需自定义模型映射和服务器设置：
+    编辑 [`.env`](./.env.example) 文件，填入您的 Gemini API 密钥，并可按需自定义模型映射和服务器设置：
 
-    ```dotenv
+    ```env
     # 必需: 你的 Google AI Studio API 密钥
     GEMINI_API_KEY="your-google-ai-studio-key"
 
@@ -91,8 +131,12 @@
     ANTHROPIC_BASE_URL=http://localhost:8082 claude
     ```
 
-3.  **使用 `CLAUDE.md` (关键步骤)**:
-    为了让 Gemini 更好地理解 Claude Code 的指令，请将本仓库中的 `CLAUDE.md` 文件复制到您的项目根目录。这个文件包含了针对性的指令，能显著提升 Gemini 的表现。
+3.  **使用 [`CLAUDE.md`](./CLAUDE.md) (关键步骤)**:
+    为了让 Gemini 更好地理解 Claude Code 的指令，请将本仓库中的 [`CLAUDE.md`](./CLAUDE.md) 文件复制到您的项目根目录。这个文件包含了针对性的指令，能显著提升 Gemini 的表现。
+    
+    ```bash
+    cp CLAUDE.md /your/project/directory/
+    ```
 
 ## 工作原理
 
@@ -104,8 +148,30 @@
 
 ## 贡献
 
-欢迎提交问题、功能请求或代码贡献！
+我们热烈欢迎您的贡献！无论是提交问题报告、功能请求还是代码贡献，都能帮助这个项目变得更好。
+
+### 如何贡献
+
+1. Fork 这个仓库
+2. 创建您的功能分支 (`git checkout -b feature/AmazingFeature`)
+3. 提交您的更改 (`git commit -m 'Add some AmazingFeature'`)
+4. 推送到分支 (`git push origin feature/AmazingFeature`)
+5. 开启一个 Pull Request
+
+### 问题反馈
+
+如果您遇到任何问题或有改进建议，请在 [Issues](../../issues) 页面提交。
+
+## 许可证
+
+本项目采用 MIT 许可证 - 查看 [LICENSE](./LICENSE) 文件了解详情。
 
 ## 致谢
 
 该项目深受 [gemini-code @coffeegrind123](https://github.com/coffeegrind123/gemini-code) 的启发，并建立在其开创性的工作之上。
+
+特别感谢：
+- [Anthropic](https://www.anthropic.com/) 提供的 Claude Code CLI 工具
+- [Google](https://ai.google.dev/) 提供的强大 Gemini API
+- [LiteLLM](https://github.com/BerriAI/litellm) 项目提供的优秀 API 统一接口
+- 所有为这个项目贡献代码和反馈的开发者们