History

Update README

hkfires committed 1 year ago

Commit 1bb0d111 parent 6164f5c2 files · +24 −12Browse files

Unified · Split

2 files
  1. README.md +12 −6
  2. README_CN.md +12 −6
README.md+12−6
@@ -497,30 +497,36 @@ docker run --rm -p 8317:8317 -v /path/to/your/config.yaml:/CLIProxyAPI/config.ya · 496 unmodified lines
497497
498498 ## Run with Docker Compose
499499
500−1. Create a `config.yaml` from `config.example.yaml` and customize it.
500+1. Clone the repository:
501+ ```bash
502+ git clone https://github.com/luispater/CLIProxyAPI.git
503+ cd CLIProxyAPI
504+ ```
505+
506+2. Create a `config.yaml` from `config.example.yaml` and customize it.
501507
502−2. Build and start the services using the build scripts:
508+3. Build and start the services using the build scripts:
503509 - For Windows (PowerShell):
504510 ```powershell
505− ./docker-build.ps1
511+ .\docker-build.ps1
506512 ```
507513 - For Linux/macOS:
508514 ```bash
509515 bash docker-build.sh
510516 ```
511517
512−3. To authenticate with providers, run the login command inside the container:
518+4. To authenticate with providers, run the login command inside the container:
513519 - **Gemini**: `docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --login`
514520 - **OpenAI (Codex)**: `docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --codex-login`
515521 - **Claude**: `docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --claude-login`
516522 - **Qwen**: `docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --qwen-login`
517523
518−4. To view the server logs:
524+5. To view the server logs:
519525 ```bash
520526 docker compose logs -f
521527 ```
522528
523−5. To stop the application:
529+6. To stop the application:
524530 ```bash
525531 docker compose down
526532 ```
README_CN.md+12−6
@@ -512,30 +512,36 @@ docker run --rm -p 8317:8317 -v /path/to/your/config.yaml:/CLIProxyAPI/config.ya · 511 unmodified lines
512512
513513 ## 使用 Docker Compose 运行
514514
515−1. 从 `config.example.yaml` 创建一个 `config.yaml` 文件并进行自定义。
515+1. 克隆仓库:
516+ ```bash
517+ git clone https://github.com/luispater/CLIProxyAPI.git
518+ cd CLIProxyAPI
519+ ```
520+
521+2. 从 `config.example.yaml` 创建一个 `config.yaml` 文件并进行自定义。
516522
517−2. 使用构建脚本构建并启动服务:
523+3. 使用构建脚本构建并启动服务:
518524 - Windows (PowerShell):
519525 ```powershell
520− ./docker-build.ps1
526+ .\docker-build.ps1
521527 ```
522528 - Linux/macOS:
523529 ```bash
524530 bash docker-build.sh
525531 ```
526532
527−3. 要在容器内运行登录命令进行身份验证:
533+4. 要在容器内运行登录命令进行身份验证:
528534 - **Gemini**: `docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --login`
529535 - **OpenAI (Codex)**: `docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --codex-login`
530536 - **Claude**: `docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --claude-login`
531537 - **Qwen**: `docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --qwen-login`
532538
533−4. 查看服务器日志:
539+5. 查看服务器日志:
534540 ```bash
535541 docker compose logs -f
536542 ```
537543
538−5. 停止应用程序:
544+6. 停止应用程序:
539545 ```bash
540546 docker compose down
541547 ```