From 483229779c084656ce42de0eff9c36f49a3dfdf7 Mon Sep 17 00:00:00 2001 From: Luis Pater Date: Fri, 26 Sep 2025 02:57:49 +0800 Subject: [PATCH] chore(docs): update README with GUI client, WebUI links, and detailed SDK documentation - Added references to EasyCLI and Cli-Proxy-API-Management-Center in both English and Chinese README files. - Updated SDK documentation section with new links for access, watcher, and custom provider examples. --- README.md | 17 +++++++++++++++-- README_CN.md | 16 ++++++++++++++-- 2 files changed, 29 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index fa8752917..c6adff451 100644 --- a/README.md +++ b/README.md @@ -62,6 +62,16 @@ The first Chinese provider has now been added: [Qwen Code](https://github.com/Qw ## Usage +### GUI Client & Official WebUI + +#### [EasyCLI](https://github.com/router-for-me/EasyCLI) + +A cross-platform desktop GUI client for CLIProxyAPI. + +#### [Cli-Proxy-API-Management-Center](https://github.com/router-for-me/Cli-Proxy-API-Management-Center) + +A web-based management center for CLIProxyAPI. + ### Authentication You can authenticate for Gemini, OpenAI, and/or Claude. All can coexist in the same `auth-dir` and will be load balanced. @@ -626,8 +636,11 @@ see [MANAGEMENT_API.md](MANAGEMENT_API.md) ## SDK Docs -- Usage: `docs/sdk-usage.md` (中文: `docs/sdk-usage_CN.md`) -- Advanced (executors & translators): `docs/sdk-advanced.md` (中文: `docs/sdk-advanced_CN.md`) +- Usage: [docs/sdk-usage.md](docs/sdk-usage.md) +- Advanced (executors & translators): [docs/sdk-advanced.md](docs/sdk-advanced.md) +- Access: [docs/sdk-access.md](docs/sdk-access.md) +- Watcher: [docs/sdk-watcher.md](docs/sdk-watcher.md) +- Custom Provider Example: `examples/custom-provider` ## Contributing diff --git a/README_CN.md b/README_CN.md index 602a6324d..cf206659a 100644 --- a/README_CN.md +++ b/README_CN.md @@ -75,6 +75,16 @@ ## 使用方法 +### 图形客户端与官方 WebUI + +#### [EasyCLI](https://github.com/router-for-me/EasyCLI) + +CLIProxyAPI 的跨平台桌面图形客户端。 + +#### [Cli-Proxy-API-Management-Center](https://github.com/router-for-me/Cli-Proxy-API-Management-Center) + +CLIProxyAPI 的基于 Web 的管理中心。 + ### 身份验证 您可以分别为 Gemini、OpenAI 和 Claude 进行身份验证,三者可同时存在于同一个 `auth-dir` 中并参与负载均衡。 @@ -635,8 +645,10 @@ docker run --rm -p 8317:8317 -v /path/to/your/config.yaml:/CLIProxyAPI/config.ya ## SDK 文档 -- 使用文档:`docs/sdk-usage_CN.md`(English: `docs/sdk-usage.md`) -- 高级(执行器与翻译器):`docs/sdk-advanced_CN.md`(English: `docs/sdk-advanced.md`) +- 使用文档:[docs/sdk-usage_CN.md](docs/sdk-usage_CN.md) +- 高级(执行器与翻译器):[docs/sdk-advanced_CN.md](docs/sdk-advanced_CN.md) +- 认证: [docs/sdk-access_CN.md](docs/sdk-access_CN.md) +- 凭据加载/更新: [docs/sdk-watcher_CN.md](docs/sdk-watcher_CN.md) - 自定义 Provider 示例:`examples/custom-provider` ## 贡献