Merge pull request #31 from MiniMax-AI-Dev/docs/readme-polish

docs: polish README with logo, badges, and features overview

Author: RyanLee-Dev

README.md

@@ -1,41 +1,61 @@
-# minimax-cli
-
-CLI for the [MiniMax AI Platform](https://platform.minimax.io) — generate text, images, video, speech, and music from the terminal.
-
-Supports **Global** (`api.minimax.io`) and **CN** (`api.minimaxi.com`) with automatic region detection.
-
-[中文文档](README_CN.md)
-
----
+<p align="center">
+  <img src="assets/logo.png" alt="MiniMax" width="320" />
+</p>
+
+<p align="center">
+  <strong>The official CLI for the MiniMax AI Platform</strong><br>
+  Generate text, images, video, speech, and music — all from your terminal.
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/minimax-cli"><img src="https://img.shields.io/npm/v/minimax-cli.svg" alt="npm version" /></a>
+  <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License: MIT" /></a>
+  <a href="https://nodejs.org"><img src="https://img.shields.io/badge/node-%3E%3D18-brightgreen.svg" alt="Node.js >= 18" /></a>
+</p>
+
+<p align="center">
+  <a href="README_CN.md">中文文档</a> · <a href="https://platform.minimax.io">Platform</a>
+</p>
+
+## Features
+
+- **Text** — Multi-turn chat, streaming, system prompts, JSON output
+- **Image** — Text-to-image with aspect ratio and batch controls
+- **Video** — Async video generation with progress tracking
+- **Speech** — TTS with 30+ voices, speed control, streaming playback
+- **Music** — Text-to-music with optional lyrics
+- **Vision** — Image understanding and description
+- **Search** — Web search powered by MiniMax
+- **Dual Region** — Seamless Global (`api.minimax.io`) and CN (`api.minimaxi.com`) support
 
 ## Install
 
-Requires [Node.js](https://nodejs.org) 18+.
-
 ```bash
 npm install -g minimax-cli
 ```
 
----
+> Requires [Node.js](https://nodejs.org) 18+
 
 ## Quick Start
 
 ```bash
+# Authenticate
 minimax auth login --api-key sk-xxxxx
 
+# Start creating
 minimax text chat --message "What is MiniMax?"
 minimax image "A cat in a spacesuit"
 minimax speech synthesize --text "Hello!" --out hello.mp3
+minimax video generate --prompt "Ocean waves at sunset"
+minimax music "Upbeat pop"
 minimax search "MiniMax AI latest news"
 minimax vision photo.jpg
 minimax quota
 ```
 
----
-
 ## Commands
 
-### Text
+### `minimax text`
 
 ```bash
 minimax text chat --message "Write a poem"
@@ -45,15 +65,15 @@ minimax text chat --message "user:Hi" --message "assistant:Hey!" --message "How
 cat messages.json | minimax text chat --messages-file - --output json
 ```
 
-### Image
+### `minimax image`
 
 ```bash
-minimax image "A cat in a spacesuit"              # shorthand
+minimax image "A cat in a spacesuit"
 minimax image generate --prompt "A cat" --n 3 --aspect-ratio 16:9
 minimax image generate --prompt "Logo" --out-dir ./out/
 ```
 
-### Video
+### `minimax video`
 
 ```bash
 minimax video generate --prompt "Ocean waves at sunset" --async
@@ -62,7 +82,7 @@ minimax video task get --task-id 123456
 minimax video download --file-id 176844028768320 --out video.mp4
 ```
 
-### Speech
+### `minimax speech`
 
 ```bash
 minimax speech synthesize --text "Hello!" --out hello.mp3
@@ -72,38 +92,29 @@ echo "Breaking news" | minimax speech synthesize --text-file - --out news.mp3
 minimax speech voices
 ```
 
-### Music
+### `minimax music`
 
 ```bash
-minimax music "Upbeat pop"                        # shorthand
+minimax music "Upbeat pop"
 minimax music generate --prompt "Jazz" --lyrics "La la la" --out song.mp3
 ```
 
-### Vision
+### `minimax vision`
 
 ```bash
-minimax vision photo.jpg                          # shorthand
+minimax vision photo.jpg
 minimax vision describe --image https://example.com/img.jpg --prompt "What breed?"
 minimax vision describe --file-id file-123
 ```
 
-### Search
+### `minimax search`
 
 ```bash
-minimax search "MiniMax AI"                       # shorthand
+minimax search "MiniMax AI"
 minimax search query --q "latest news" --output json
 ```
 
-### Quota & Config
-
-```bash
-minimax quota
-minimax config show
-minimax config set --key region --value cn
-minimax config export-schema | jq .
-```
-
-### Auth
+### `minimax auth`
 
 ```bash
 minimax auth login --api-key sk-xxxxx
@@ -113,15 +124,22 @@ minimax auth refresh
 minimax auth logout
 ```
 
-### Update
+### `minimax config` · `minimax quota`
+
+```bash
+minimax quota
+minimax config show
+minimax config set --key region --value cn
+minimax config export-schema | jq .
+```
+
+### `minimax update`
 
 ```bash
 minimax update
 minimax update latest
 ```
 
----
-
 ## License
 
-MIT
+[MIT](LICENSE)

README_CN.md

@@ -1,41 +1,61 @@
-# minimax-cli
-
-[MiniMax AI 开放平台](https://platform.minimaxi.com) 的命令行工具——在终端生成文字、图像、视频、语音和音乐。
-
-支持**国际版**（`api.minimax.io`）和**国内版**（`api.minimaxi.com`），自动识别区域。
-
-[English](README.md)
-
----
+<p align="center">
+  <img src="assets/logo.png" alt="MiniMax" width="320" />
+</p>
+
+<p align="center">
+  <strong>MiniMax AI 开放平台官方命令行工具</strong><br>
+  在终端生成文字、图像、视频、语音和音乐。
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/minimax-cli"><img src="https://img.shields.io/npm/v/minimax-cli.svg" alt="npm version" /></a>
+  <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License: MIT" /></a>
+  <a href="https://nodejs.org"><img src="https://img.shields.io/badge/node-%3E%3D18-brightgreen.svg" alt="Node.js >= 18" /></a>
+</p>
+
+<p align="center">
+  <a href="README.md">English</a> · <a href="https://platform.minimaxi.com">开放平台</a>
+</p>
+
+## 功能特性
+
+- **文本对话** — 多轮对话、流式输出、系统提示词、JSON 格式输出
+- **图像生成** — 文生图，支持比例和批量控制
+- **视频生成** — 异步生成，进度追踪
+- **语音合成** — 30+ 音色、语速调节、流式播放
+- **音乐生成** — 文生音乐，支持自定义歌词
+- **图像理解** — 图片描述与识别
+- **网络搜索** — MiniMax 搜索引擎
+- **双区域** — 国际版（`api.minimax.io`）和国内版（`api.minimaxi.com`）自动切换
 
 ## 安装
 
-需要 [Node.js](https://nodejs.org) 18+。
-
 ```bash
 npm install -g minimax-cli
 ```
 
----
+> 需要 [Node.js](https://nodejs.org) 18+
 
 ## 快速开始
 
 ```bash
+# 认证
 minimax auth login --api-key sk-xxxxx
 
+# 开始创作
 minimax text chat --message "你好，MiniMax！"
 minimax image "一只穿宇航服的猫"
 minimax speech synthesize --text "你好！" --out hello.mp3
+minimax video generate --prompt "海浪拍打礁石"
+minimax music "欢快的流行乐"
 minimax search "MiniMax AI 最新动态"
 minimax vision photo.jpg
 minimax quota
 ```
 
----
-
 ## 命令参考
 
-### 文本对话
+### `minimax text`
 
 ```bash
 minimax text chat --message "写一首诗"
@@ -45,15 +65,15 @@ minimax text chat --message "user:你好" --message "assistant:嗨！" --message
 cat messages.json | minimax text chat --messages-file - --output json
 ```
 
-### 图像生成
+### `minimax image`
 
 ```bash
-minimax image "一只穿宇航服的猫"                    # 简写
+minimax image "一只穿宇航服的猫"
 minimax image generate --prompt "科技感 Logo" --n 3 --aspect-ratio 16:9
 minimax image generate --prompt "山水画" --out-dir ./output/
 ```
 
-### 视频生成
+### `minimax video`
 
 ```bash
 minimax video generate --prompt "海浪拍打礁石" --async
@@ -62,66 +82,64 @@ minimax video task get --task-id 123456
 minimax video download --file-id 176844028768320 --out video.mp4
 ```
 
-### 语音合成
+### `minimax speech`
 
 ```bash
 minimax speech synthesize --text "你好！" --out hello.mp3
 minimax speech synthesize --text "流式输出" --stream | mpv -
 minimax speech synthesize --text "Hi" --voice Boyan_new_hailuo --speed 1.2
 echo "头条新闻" | minimax speech synthesize --text-file - --out news.mp3
-minimax speech voices                             # 列出可用音色
+minimax speech voices
 ```
 
-### 音乐生成
+### `minimax music`
 
 ```bash
-minimax music "欢快的流行乐"                         # 简写
+minimax music "欢快的流行乐"
 minimax music generate --prompt "爵士风" --lyrics "啦啦啦" --out song.mp3
 ```
 
-### 图像理解
+### `minimax vision`
 
 ```bash
-minimax vision photo.jpg                          # 简写
+minimax vision photo.jpg
 minimax vision describe --image https://example.com/img.jpg --prompt "这是什么品种的狗？"
 minimax vision describe --file-id file-123
 ```
 
-### 网络搜索
+### `minimax search`
 
 ```bash
-minimax search "MiniMax AI"                       # 简写
+minimax search "MiniMax AI"
 minimax search query --q "最新动态" --output json
 ```
 
-### 配额与配置
+### `minimax auth`
 
 ```bash
-minimax quota                                     # 查看配额用量
-minimax config show
-minimax config set --key region --value cn
-minimax config export-schema | jq .
+minimax auth login --api-key sk-xxxxx
+minimax auth login                    # OAuth 浏览器授权
+minimax auth status
+minimax auth refresh
+minimax auth logout
 ```
 
-### 认证
+### `minimax config` · `minimax quota`
 
 ```bash
-minimax auth login --api-key sk-xxxxx             # API Key 登录
-minimax auth login                                # OAuth 浏览器授权
-minimax auth status
-minimax auth refresh
-minimax auth logout
+minimax quota
+minimax config show
+minimax config set --key region --value cn
+minimax config export-schema | jq .
 ```
 
-### 更新
+### `minimax update`
 
 ```bash
 minimax update
 minimax update latest
 ```
 
----
-
 ## 许可证
 
-MIT
+[MIT](LICENSE)