Update README.md

README.md

@@ -1,12 +1,110 @@
----
-title: Replicate API Proxy
-emoji: 🔄
-colorFrom: blue
-colorTo: green
-sdk: gradio
-sdk_version: 4.7.1
-app_file: app.py
-pinned: false
-license: mit
----
+# Replicate API Proxy for LobeChat
 
+这是一个部署在 Hugging Face Spaces 上的代理服务，用于将 Replicate API 转换为 OpenAI 兼容的 API 格式，以便在 LobeChat 等第三方客户端中使用。
+
+## 功能特性
+
+- 🔄 将 OpenAI 格式的请求转换为 Replicate API 格式
+- 📡 支持流式和非流式响应
+- 🌐 兼容 LobeChat、ChatGPT-Next-Web 等客户端
+- 🚀 一键部署到 Hugging Face Spaces
+- 🔒 安全的 API 密钥管理
+
+## 部署步骤
+
+### 1. 在 Hugging Face 上创建 Space
+
+1. 访问 [Hugging Face Spaces](https://huggingface.co/spaces)
+2. 点击 "Create new Space"
+3. 填写以下信息：
+   - Space name: `replicate-api-proxy`
+   - License: `MIT`
+   - SDK: `Docker`
+   - Hardware: `CPU basic` (免费)
+
+### 2. 上传文件
+
+将以下文件上传到你的 Space：
+- `app.py`
+- `requirements.txt`
+- `Dockerfile`
+- `README.md`
+
+### 3. 配置环境变量
+
+在 Space 的 Settings 页面中，添加以下环境变量：
+- `REPLICATE_API_TOKEN`: 你的 Replicate API 密钥
+
+### 4. 部署
+
+上传完文件后，Space 会自动开始构建和部署。
+
+## 在 LobeChat 中使用
+
+1. 打开 LobeChat 设置
+2. 在模型服务提供商中添加自定义 OpenAI 服务
+3. 填写以下信息：
+   - API 地址: `https://你的用户名-replicate-api-proxy.hf.space/v1`
+   - API 密钥: 任意值（代理会使用环境变量中的 Replicate 密钥）
+   - 模型列表: `claude-4-sonnet,claude-3-sonnet,claude-3-haiku`
+
+## 支持的模型
+
+- `claude-4-sonnet`: Anthropic Claude 4 Sonnet
+- `claude-3-sonnet`: Anthropic Claude 3 Sonnet  
+- `claude-3-haiku`: Anthropic Claude 3 Haiku
+
+## API 端点
+
+### GET /
+健康检查端点
+
+### GET /v1/models
+列出可用模型（兼容 OpenAI API）
+
+### POST /v1/chat/completions
+聊天完成端点（兼容 OpenAI API）
+
+支持的参数：
+- `model`: 模型名称
+- `messages`: 消息数组
+- `stream`: 是否流式响应
+- `max_tokens`: 最大生成令牌数
+- `temperature`: 温度参数
+
+## 示例请求
+
+```bash
+curl -X POST "https://你的用户名-replicate-api-proxy.hf.space/v1/chat/completions" \
+  -H "Content-Type: application/json" \
+  -H "Authorization: Bearer your-api-key" \
+  -d '{
+    "model": "claude-4-sonnet",
+    "messages": [
+      {
+        "role": "user",
+        "content": "Hello, how are you?"
+      }
+    ],
+    "stream": true
+  }'
+```
+
+## 注意事项
+
+1. 确保你有有效的 Replicate API 密钥
+2. Hugging Face Spaces 的免费配额可能有限制
+3. 流式响应可能会有轻微延迟
+4. 建议在生产环境中使用付费的 Hugging Face 硬件
+
+## 故障排除
+
+如果遇到问题，请检查：
+1. Replicate API 密钥是否正确配置
+2. Space 是否正常运行
+3. 网络连接是否正常
+4. 查看 Space 的日志输出
+
+## 许可证
+
+MIT License