Przeglądaj źródła

readme: update usage (#80)

zijiren 9 miesięcy temu
rodzic
commit
e1d81cb5c4
2 zmienionych plików z 26 dodań i 6 usunięć
  1. 13 3
      README.md
  2. 13 3
      README.zh.md

+ 13 - 3
README.md

@@ -4,7 +4,7 @@ English | [简体中文](./README.zh.md)
 
 Next-generation AI gateway, using OpenAI as the protocol entry point.
 
-## New Feature
+## Feature
 
 - Intelligent error retry
 - Channel selection based on priority and error rate
@@ -35,15 +35,25 @@ Next-generation AI gateway, using OpenAI as the protocol entry point.
 - Inline tiktoken, no need to download tiktoken file
 - API `Swagger` documentation support `http://host:port/swagger/index.html`
 
+## How to use
+
+### Sealos
+
+Use Sealos built-in model capabilities, click to [Sealos](https://usw.sealos.io/?openapp=system-aiproxy).
+
+### FastGPT
+
+Use AI Proxy to access models, click to [FastGPT](https://doc.tryfastgpt.ai/docs/development/modelconfig/ai-proxy/).
+
 ## Deploy
 
-## Use Docker
+### Use Docker
 
 ```bash
 docker run -d --name aiproxy -p 3000:3000 -v $(pwd)/aiproxy:/aiproxy ghcr.io/labring/aiproxy:latest
 ```
 
-## Use Docker Compose
+### Use Docker Compose
 
 Copy [docker-compose.yaml](./docker-compose.yaml) to directory.
 

+ 13 - 3
README.zh.md

@@ -5,7 +5,7 @@
 
 新一代 AI 网关,使用 OpenAI 作为协议入口。
 
-## 新功能
+## 特效
 
 - 智能错误重试
 - 基于优先级与错误率选择渠道
@@ -36,15 +36,25 @@
 - 内敛分词器,无需额外下载 tiktoken 文件
 - API `Swagger` 文档支持 `http://host:port/swagger/index.html`
 
+## 如何使用
+
+### Sealos
+
+使用Sealos 内置模型能力,点击前往 [Sealos](https://hzh.sealos.run/?openapp=system-aiproxy)。
+
+### FastGPT
+
+通过 AI Proxy 接入模型,点击前往 [FastGPT](https://doc.tryfastgpt.ai/docs/development/modelconfig/ai-proxy/)。
+
 ## 部署
 
-## 使用 Docker
+### 使用 Docker
 
 ```bash
 docker run -d --name aiproxy -p 3000:3000 -v $(pwd)/aiproxy:/aiproxy ghcr.io/labring/aiproxy:latest
 ```
 
-## 使用 Docker Compose
+### 使用 Docker Compose
 
 将 [docker-compose.yaml](./docker-compose.yaml) 复制到目录。