docs: update readme

Author: nianyi778

README.md

@@ -2,121 +2,76 @@
 
 [🇨🇳 中文文档](./README.zh.md) | [🇺🇸 English](./README.en.md)
 
-**gix** is a Git extension CLI tool designed to simplify common Git workflows like commit merging and force pushing. Built with TypeScript, it is extensible, interactive, and ready for automation.
+**gix** is a Git extension CLI tool designed to simplify your Git workflows — especially for merging commits and force pushing, with safety and clarity.
 
 ---
 
 ## 🚀 Features
 
 - 🔧 Interactively merge multiple Git commits
-- 💬 Customize commit message
-- 🚦 Optional force-push confirmation (enabled by default)
-- 🧱 Fully typed TypeScript support
-- 🔌 Easy to extend with commands like `undo`, `squash`, etc.
+- 💬 Custom commit message input
+- 🚦 Confirm force push automatically
+- 🧱 Fully typed, powered by TypeScript
+- 🔌 Modular command system — more to come
 
 ---
 
 ## 📦 Installation
 
-### ✅ Option 1: Install via npm (Recommended for most users)
-
 ```bash
 npm install -g gix
 ```
 
-Then simply run:
+Then use it globally:
 
 ```bash
 gix merge
 ```
 
-Use this for quickly merging commits in daily development workflows.
-
 ---
 
-### 🛠 Option 2: Clone the repo and develop locally (For contributors/devs)
+## 🛠 Usage Examples
 
-```bash
-git clone https://github.com/nianyi778/gix-cli.git
-cd gix
-pnpm install
-pnpm build
-pnpm link
-```
-
-Then you can use the CLI globally:
+### Merge commits
 
 ```bash
 gix merge
 ```
 
-#### If you encounter a `pnpm link` error (ERR_PNPM_NO_GLOBAL_BIN_DIR):
+Follow the prompts to:
+- Select start and end commits
+- Write a new commit message
+- Optionally force-push
+
+Or directly:
 
 ```bash
-pnpm setup
-source ~/.zshrc  # Or restart your terminal
+gix merge -f <from> -m "your message"
 ```
 
----
-
-## 🧪 Usage Example
+### Squash commits
 
 ```bash
-gix merge
+gix squash -n 3      # squash last 3 commits
 ```
 
-You will be prompted to enter:
-
-- ✅ Start commit hash (required)
-- ✅ End commit hash (optional, default is HEAD)
-- ✅ New commit message
-- ✅ Whether to force push (default is yes)
-
-### Direct command-line usage:
-
 ```bash
-gix merge -f a1b2c3d -m "feat: optimize printer logic"
+gix squash --all     # squash all history from root
 ```
 
----
-
-## 📄 Available Commands
-
-- `gix merge`: Merge multiple commits and optionally force-push
-
-### Coming soon
-
-- `gix squash`: Interactively squash recent commits
-- `gix undo`: Revert the last merge/reset
-- `gix log`: Print formatted commit log history
-
----
-
-## 👨‍💻 Development
+### Check your Git state
 
 ```bash
-pnpm dev       # Dev mode (ts-node + esm loader)
-pnpm build     # Build output using tsup
+gix doctor
 ```
 
----
-
-## 📦 Publish
-
-1. Bump version: `npm version patch | minor | major`
-2. Build output: `pnpm build`
-3. Login to npm: `npm login`
-4. Publish: `npm publish`
-
----
-
-## ✨ Badges
-
-![npm](https://img.shields.io/npm/v/gix?style=flat-square)
-![license](https://img.shields.io/npm/l/gix?style=flat-square)
+- Check git & node version
+- Git repo state
+- Working directory clean?
+- Remote & branch info
 
 ---
 
 ## 📄 License
 
-MIT © 2025 [License](./LICENSE)
+MIT © 2025 [Nian Yi](./LICENSE)

README.zh.md

@@ -2,121 +2,77 @@
 
 [🇨🇳 中文文档](./README.zh.md) | [🇺🇸 English](./README.en.md)
 
-**gix** 是一个 Git 扩展命令行工具，旨在简化 Git 常见操作，如合并多个提交、自动强推等。基于 TypeScript 构建，具有良好的可扩展性和交互体验。
+**gix** 是一个 Git 扩展命令行工具，专为合并提交、强推等 Git 流程优化而设计，提供交互式体验和类型安全支持。
 
 ---
 
 ## 🚀 功能特性
 
 - 🔧 交互式合并多个 Git 提交
 - 💬 自定义提交信息
-- 🚦 自动强推前进行确认提示（默认开启）
+- 🚦 自动确认是否强推（默认开启）
 - 🧱 使用 TypeScript 编写，类型安全
-- 🔌 易于扩展更多命令（如 `undo`、`squash` 等）
+- 🔌 命令模块化设计，易于扩展
 
 ---
 
 ## 📦 安装方式
 
-### ✅ 方式一：通过 npm 全局安装（推荐普通用户使用）
-
 ```bash
 npm install -g gix
 ```
 
-安装后，你可以直接运行：
+安装后即可全局使用：
 
 ```bash
 gix merge
 ```
 
-适合日常开发中快速合并 commit 的使用场景。
-
 ---
 
-### 🛠 方式二：克隆源码并本地开发（适合贡献者/开发者）
-
-```bash
-git clone https://github.com/nianyi778/gix-cli.git
-cd gix
-pnpm install
-pnpm build
-pnpm link
-```
+## 🛠 使用示例
 
-然后你可以全局使用：
+### 合并提交
 
 ```bash
 gix merge
 ```
 
-#### 如果遇到 `pnpm link` 报错（ERR_PNPM_NO_GLOBAL_BIN_DIR）：
+交互输入：
+- 起始和结束 commit（可选）
+- 新的 commit 信息
+- 是否强推
+
+或直接命令行执行：
 
 ```bash
-pnpm setup
-source ~/.zshrc  # 或重启终端
+gix merge -f <from> -m "你的提交信息"
 ```
 
----
-
-## 🛠 使用示例
+### 压缩提交（Squash）
 
 ```bash
-gix merge
+gix squash -n 3       # 合并最近 3 次提交
 ```
 
-将提示你输入：
-
-- ✅ 起始提交 hash（必填）
-- ✅ 结束提交 hash（可选，默认 HEAD）
-- ✅ 新的提交信息
-- ✅ 是否自动强推（默认是）
-
-### 命令行参数方式：
-
 ```bash
-gix merge -f a1b2c3d -m "feat: 优化打印逻辑"
+gix squash --all      # 从第一个提交开始合并（全量 squash）
 ```
 
----
-
-## 📄 可用命令
-
-- `gix merge`：合并多个提交并可选择强推
-
-### 即将支持
-
-- `gix squash`：自动合并最近多个提交
-- `gix undo`：撤销上次 merge/reset 操作
-- `gix log`：输出合并历史日志
-
----
-
-## 👨‍💻 开发指南
+### 检查当前 Git 状态
 
 ```bash
-pnpm dev       # 开发模式（使用 ts-node + esm loader）
-pnpm build     # 使用 tsup 构建产物
+gix doctor
 ```
 
----
-
-## 📦 发布说明
-
-1. 更新版本号：`npm version patch | minor | major`
-2. 构建产物：`pnpm build`
-3. 登录 npm：`npm login`
-4. 发布包：`npm publish`
-
----
-
-## ✨ 徽章展示
-
-![npm](https://img.shields.io/npm/v/gix?style=flat-square)
-![license](https://img.shields.io/npm/l/gix?style=flat-square)
+- 检查 Git 和 Node 版本
+- 当前是否为 Git 仓库
+- 工作区是否干净
+- 是否配置远程仓库
+- 当前所在分支
 
 ---
 
 ## 📄 License
 
-MIT © 2025 [License](./LICENSE)
+MIT © 2025 [Nian Yi](./LICENSE)