docs: rewrite the readme document

Author: ikxin

README.md

@@ -13,154 +13,169 @@
 </p>
 
 <p align="center" class="hidden">
-  <a href="./README_EN.md">English</a>
+  <a href="./README_ZH.md">简体中文</a>
 </p>
 
-## 📖 介绍
+## 📖 Introduction
 
-一站式 KMS 工具箱，集成了 KMS 激活脚本生成、KMS 服务器检测、KMS 服务器状态监控等功能。
+An all-in-one KMS toolbox that integrates features such as KMS activation script generation, KMS server detection, and KMS server status monitoring.
 
-该项目最早诞生于 2020 年 4 月，首发在 [Hostloc 论坛](https://hostloc.com/thread-669158-1-1.html)，之前仅仅只是一个用来生成 KMS 激活脚本的小工具。上大学的时候我在学校负责维护教学楼和机房的电脑设备，平日里经常需要重装各种各样版本的操作系统，这个小工具提高了激活操作系统的效率。于是在 2022 年 6 月，我将这个小工具翻出来，使用许多新技术对其进行了重构，再一次发布到了 [Hostloc 论坛](https://hostloc.com/thread-1026408-1-1.html)，得到了许多大佬的关注和支持。
+## 📦 Project Demo
 
-后来的一段时间里也会偶尔更新一些功能，但一直都没有很完善，直到前些时候收到了两个特别的 issues「[#25](https://github.com/ikxin/kms-tools/issues/25)、[#26](https://github.com/ikxin/kms-tools/issues/26)」，其中有一个还是非中文语言发起的，我没有想到一个小小的项目能够得到海外朋友的关注。作为我开源的第一款「处女作」，我决定将其继续开发和维护下去。
+### Full-Stack Version
 
-原先的版本是一个纯前端的工具，为了实现 KMS 检测和 KMS 监控等功能，我使用 Bun + Elysia 写了一个后端服务，将整个项目区分为纯前端版本和全栈版本，前端版本可以调用 [kms.ikxin.com](https://kms.ikxin.com) 的 API 接口，而全栈版本则可以独立部署所有功能，甚至包含了 Vlmcsd 来作为 KMS 激活服务器。
+Thanks to [Zebaur](https://zeabur.com/referral?referralCode=ikxin&utm_source=ikxin&utm_campaign=oss) for providing services for project deployment.
 
-## 📦 在线使用
+- [kms.ikxin.com](https://kms.ikxin.com)
 
-### 全栈版本
+### Frontend Version
 
-- 官网地址: [kms.ikxin.com](https://kms.ikxin.com)
-
-### 纯前端版本
+By default, it calls the API interface of [kms.ikxin.com](https://kms.ikxin.com), but you can also deploy your own backend service.
 
 - Cloudflare: [kmstools.pages.dev](https://kmstools.pages.dev)
 - Vercel: [kmstools.vercel.app](https://kmstools.vercel.app)
+- Netlify: [kms-tools.netlify.app](https://kms-tools.netlify.app)
 
-## 🌈 功能预览
+## 🌈 Feature Preview
 
-| KMS 激活脚本生成                      | KMS 服务器检测                     | KMS 服务器状态监控                   |
+| KMS Activation Script Generation      | KMS Server Detection               | KMS Server Status Monitoring         |
 | ------------------------------------- | ---------------------------------- | ------------------------------------ |
 | ![](./src/assets/images/activate.png) | ![](./src/assets/images/check.png) | ![](./src/assets/images/monitor.png) |
 
-## 👀 历史版本
+## ✨ Tech Stack
 
-| v1.2.0                              | v1.0.0                              | v0.1.5                              |
-| ----------------------------------- | ----------------------------------- | ----------------------------------- |
-| ![](./src/assets/images/v1.2.0.png) | ![](./src/assets/images/v1.0.0.png) | ![](./src/assets/images/v0.1.5.png) |
+- [Nuxt](https://github.com/nuxt/nuxt) - Full-stack web application framework based on Vue.js
+- [Vue.js](https://github.com/vuejs/core) - Progressive JavaScript framework
+- [Nitro](https://github.com/nitrojs/nitro) - High-performance web server framework based on unjs/h3
+- [Vite](https://github.com/vitejs/vite) - Fast development server and modern build tool
+- [VueUse](https://github.com/vueuse/vueuse) - Collection of utility functions based on the Composition API
+- [Tailwind CSS](https://github.com/tailwindlabs/tailwindcss) - Utility-first CSS framework
+- [Arco Design Vue](https://github.com/arco-design/arco-design-vue) - Enterprise-level product design system by ByteDance
+- [Nuxt I18n](https://github.com/nuxt-modules/i18n) - Internationalization support plugin for Nuxt
 
-## ✨ 技术栈
+## 📦 Deployment
 
-### 后端
+### Full-Stack Version
 
-- <img src="./src/assets/icons/logos/bun.svg" /> [Bun](https://github.com/oven-sh/bun) - 用于 JavaScript 和 TypeScript 应用程序的一体化工具包
-- <img src="./src/assets/icons/logos/drizzle.svg" /> [Drizzle ORM](https://github.com/drizzle-team/drizzle-orm) - 下一代的无头 TypeScript ORM 框架
-- <img src="./src/assets/icons/logos/elysia.svg" /> [Elysia](https://github.com/elysiajs/elysia) - 符合人体工程学的 Web 框架，用于使用 Bun 构建后端服务器
+#### Zeabur Deployment
 
-### 前端
+[![Deployed on Zeabur](https://zeabur.com/deployed-on-zeabur-dark.svg)](https://zeabur.com/templates/TXR0D9)
 
-- <img src="./src/assets/icons/logos/vue.svg" /> [Vue.js](https://github.com/vuejs/core) - 构建用户界面的 JavaScript 框架
-- <img src="./src/assets/icons/logos/vite.svg" /> [Vite](https://github.com/vitejs/vite) - 下一代的前端工程构建工具
-- <img src="./src/assets/icons/logos/arco.svg" /> [Arco Design Vue](https://github.com/arco-design/arco-design-vue) - ByteDance 开发的企业级产品设计系统
-- <img src="./src/assets/icons/logos/vue-router.svg" /> [Vue Router](https://github.com/vuejs/vue-router) - Vue.js 核心团队开发的路由组件
-- <img src="./src/assets/icons/logos/pinia.svg" /> [Pinia](https://github.com/vuejs/pinia) - 类型安全、可扩展性以及模块化设计的状态管理库
-- <img src="./src/assets/icons/logos/unocss.svg" /> [UnoCSS](https://github.com/unocss/unocss) - 即时的按需加载原子 CSS 引擎
-- <img src="./src/assets/icons/logos/vueuse.svg" /> [VueUse](https://github.com/vueuse/vueuse) - 基于 Composition API 的实用函数集合
-- <img src="./src/assets/icons/logos/vue-i18n.svg" /> [Vue I18n](https://github.com/intlify/vue-i18n-next) - I18n 国际化语言支持
-- <img src="./src/assets/icons/logos/unjs.svg" /> [unplugin-auto-import](https://github.com/antfu/unplugin-auto-import) - 自动按需导入 Composition API 的插件
-- <img src="./src/assets/icons/logos/unjs.svg" /> [unplugin-vue-components](https://github.com/antfu/unplugin-vue-components) - 自动按需导入 Vue 组件的插件
-- <img src="./src/assets/icons/logos/unjs.svg" /> [unplugin-vue-router](https://github.com/posva/unplugin-vue-router) - Vue Router 自动加载基于文件的路由系统
-- <img src="./src/assets/icons/logos/markdown.svg" /> [unplugin-vue-markdown](https://github.com/unplugin/unplugin-vue-markdown) - Markdown 文档支持
+#### Docker Deployment
 
-## 📦 本地构建
+```bash
+docker run -d --name kms-tools -p 3000:3000 ikxin/kms-tools
+```
 
-不管是全栈版本还是纯前端版本，都需要依赖 Bun 来进行构建，使用以下脚本在本地安装 Bun 环境。
+#### Manual Deployment
 
-Linux & macOS：
+1. Clone the project repository to your local machine and install dependencies
 
 ```bash
-curl -fsSL https://bun.sh/install | bash
+git clone https://github.com/ikxin/kms-tools.git
+cd kms-tools && pnpm install
 ```
 
-Windows：
+2. Build the project
 
 ```bash
-powershell -c "irm bun.sh/install.ps1 | iex"
+pnpm run build
 ```
 
-接下来将项目克隆到本地，然后执行命令安装依赖
+3. Start the server (listening on port `3000` by default)
 
 ```bash
-git clone https://github.com/ikxin/kms-tools.git
-cd kms-tools && bun install
+node .output/server/index.mjs
 ```
 
-### 全栈版本
-
-1. 创建 MySQL 数据库，使用以下 SQL 创建表的结构
-
-```sql
-CREATE TABLE `logs` (
-  `id` int AUTO_INCREMENT NOT NULL,
-  `host` text NOT NULL,
-  `delay` int NOT NULL DEFAULT 0,
-  `content` text,
-  `status` boolean NOT NULL DEFAULT false,
-  `created_at` timestamp NOT NULL,
-  CONSTRAINT `logs_id` PRIMARY KEY(`id`)
-);
---> statement-breakpoint
-CREATE TABLE `server` (
-  `id` int AUTO_INCREMENT NOT NULL,
-  `host` text NOT NULL,
-  `port` int NOT NULL DEFAULT 1688,
-  `total` int NOT NULL DEFAULT 0,
-  `success` int NOT NULL DEFAULT 0,
-  `fail` int NOT NULL DEFAULT 0,
-  `delay` float NOT NULL DEFAULT 0,
-  `rate` float NOT NULL DEFAULT 0,
-  `updated_at` timestamp,
-  `created_at` timestamp,
-  CONSTRAINT `server_id` PRIMARY KEY(`id`)
-);
+### Frontend Version
+
+#### Cloudflare Deployment
+
+1. Fork this project to your own repository
+
+2. Create a project on Cloudflare Pages and select the forked repository
+
+3. Set the build command
+
+```bash
+pnpm run generate
 ```
 
-2. 将 `.env.example` 文件重命名为 `.env`，并修改其中的配置项
+4. Configure environment variables
+
+| Name                  | Value                   |
+| --------------------- | ----------------------- |
+| `NODE_VERSION`        | `22`                    |
+| `NUXT_PUBLIC_API_URL` | `https://kms.ikxin.com` |
+
+5. Deploy the project
+
+#### Vercel Deployment
+
+1. Fork this project to your own repository
 
-```ini
-ENABLE_VLMCSD = false # 是否启用 Vlmcsd 服务
-PORT = 3000 # 服务端口
-DATABASE_URL = 'mysql://root:password@localhost:3306/database' # 数据库连接地址
+2. Create a project on Vercel and select the forked repository
+
+3. Set the build command
+
+```bash
+pnpm run generate
 ```
 
-3. 运行以下命令启动服务
+4. Configure environment variables
+
+| Name                  | Value                   |
+| --------------------- | ----------------------- |
+| `NUXT_PUBLIC_API_URL` | `https://kms.ikxin.com` |
+
+5. Deploy the project
+
+#### Netlify Deployment
+
+1. Fork this project to your own repository
+
+2. Create a project on Netlify and select the forked repository
+
+3. Set the build command
 
 ```bash
-bun run service
+pnpm run generate
 ```
 
-### 纯前端版本
+4. Configure environment variables
+
+| Name                  | Value                   |
+| --------------------- | ----------------------- |
+| `NUXT_PUBLIC_API_URL` | `https://kms.ikxin.com` |
+
+5. Deploy the project
 
-1. 使用以下命令构建项目
+#### Manual Deployment
+
+1. Clone the project repository to your local machine and install dependencies
 
 ```bash
-bun run build
+git clone https://github.com/ikxin/kms-tools.git
+cd kms-tools && pnpm install
 ```
 
-2. 运行以下命令启动服务
+2. Build the project
 
 ```bash
-npx serve dist
+pnpm run generate
 ```
 
-## ⭐ 星星
+3. After building, upload the files from the `.output/public` directory to your server
+
+## ⭐ Stars
 
 <img class="w-full" src="https://starchart.cc/ikxin/kms-tools.svg" />
 
-## 🧑‍💻 作者
+## 🧑‍💻 Author
 
 Code with ❤️ by [一纸忘忧](https://blog.ikxin.com '一纸忘忧')
 
-## 📜 开源协议
+## 📜 License
 
-[MIT License](./LICENSE 'MIT License') Copyright (c) 2022 ~ Present
+[MIT License](./LICENSE 'MIT License') © 2022 ~ Present