From d6d53dd1275b24af0ce2e4ce25c20cbd55d22f48 Mon Sep 17 00:00:00 2001
From: Liuqh233 <528851597@qq.com>
Date: Wed, 29 May 2024 19:26:44 +0800
Subject: [PATCH] docs: update readme (#76)

---
 README.cn.md | 45 ---------------------------------------------
 README.en.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 README.md    | 22 +++++++++++-----------
 3 files changed, 59 insertions(+), 56 deletions(-)
 delete mode 100644 README.cn.md
 create mode 100644 README.en.md

diff --git a/README.cn.md b/README.cn.md
deleted file mode 100644
index 7ff3e9a..0000000
--- a/README.cn.md
+++ /dev/null
@@ -1,45 +0,0 @@
-<div align="center">
-  <a href="https://github.com/farm-fe/farm">
-  <img src="./src/assets/logo.png" width="100" />
-  </a>
-  <h3>开箱即用的Farm-react开发模版</h3>
-  <p>
-   集成了开发常用的功能,如路由,代码格式化,commit约束等
-  </p>
-  <p align="center">
-    <a href="https://discord.gg/mDErq9aFnF">
-      <img src="https://img.shields.io/badge/chat-discord-blueviolet?style=flat&logo=discord&colorA=ffe3f5&colorB=711a5f" alt="discord chat" />
-    </a>
-    <a href="https://npmjs.com/package/@farmfe/core"><img src="https://img.shields.io/npm/v/@farmfe/core.svg?style=flat-square&colorA=ffe3f5&colorB=711a5f" alt="npm package"></a>
-    <a href="https://nodejs.org/en/about/releases/"><img src="https://img.shields.io/node/v/@farmfe/core.svg?style=flat-square&colorA=ffe3f5&colorB=711a5f" alt="node compatibility"></a>
-  <a href="https://github.com/farm-fe/farm/blob/main/LICENSE">
-    <img src="https://img.shields.io/npm/l/@farmfe/core?style=flat-square&colorA=ffe3f5&colorB=711a5f" alt="license" />
-  </a>
-  </p>
-  <br/>
-</div>
-
----
-
-> 为了更好的开发体验,请在本地开发工具上[**安装Biome插件**](https://biomejs.dev/zh-cn/reference/vscode/)
->
-## RoadMap
-
-[RoadMap](https://github.com/jstors/farm-react-template/issues/21)
-
-## 使用
-
-### 用户配置
-
-所有的配置文件都在`config`目录下,可以根据自己的需求进行修改
-- `config/const.ts`: 项目中使用到的常量配置
-- `config/menu.ts`: 菜单配置
-- 
-
-
-## 集成内容
-- [Farm](https://farm-fe.github.io/zh/docs/quick-start): Rust开发的基础框架,提供了一套完整的开发体验
-- [Biome](https://biomejs.dev/zh-cn/reference/configuration/#javascriptformatterjsxquotestyle): Rust开发的lint和format工具,提升极致的开发体验
-- [arco-design](https://arco.design/react/docs/start): 一套开箱即用的React组件库
-- [vite-plugin-pages](https://github.com/hannoeru/vite-plugin-pages?tab=readme-ov-file#react-1): 提供约定式路由功能
-
diff --git a/README.en.md b/README.en.md
new file mode 100644
index 0000000..21d6f8b
--- /dev/null
+++ b/README.en.md
@@ -0,0 +1,48 @@
+<div align="center">
+
+<!--   <h3>Farm-react Starter Template</h3> -->
+  <p>
+    <img src="./src/assets/logo.png" width="30" align="center" />
+    An out-of-the-box Farm-react development template
+  </p>
+  <p align="center">
+    <a href="https://discord.gg/mDErq9aFnF">
+      <img src="https://img.shields.io/badge/chat-discord-blueviolet?style=flat&logo=discord&colorA=ffe3f5&colorB=711a5f" alt="discord chat" />
+    </a>
+    <a href="https://npmjs.com/package/@farmfe/core">
+      <img src="https://img.shields.io/npm/v/@farmfe/core.svg?style=flat-square&colorA=ffe3f5&colorB=711a5f" alt="npm package">
+    </a>
+    <a href="https://nodejs.org/en/about/releases/">
+      <img src="https://img.shields.io/node/v/@farmfe/core.svg?style=flat-square&colorA=ffe3f5&colorB=711a5f" alt="node compatibility">
+    </a>
+    <a href="https://github.com/farm-fe/farm/blob/main/LICENSE">
+      <img src="https://img.shields.io/npm/l/@farmfe/core?style=flat-square&colorA=ffe3f5&colorB=711a5f" alt="license" />
+    </a>
+  </p>
+  <br/>
+</div>
+
+  <p>
+    <img src="https://github.com/jstors/assets/blob/main/home.jpeg" align="center" />
+  </p>
+
+> For a better development experience, please install the [**Biome plugin**](https://biomejs.dev/en/reference/vscode/) on your local development tool.
+
+
+## RoadMap
+
+[RoadMap](https://github.com/jstors/farm-react-template/issues/21)
+
+## Usage
+
+### User Configuration
+
+All configuration files are located in the `config` directory and can be modified according to your needs.
+- `config/const.ts`: Contains constants used in the project.
+- `config/menu.ts`: Menu configuration
+
+## Integrated Features
+- [Farm](https://farm-fe.github.io/en/docs/quick-start): A Rust-based foundation framework that provides a complete development experience.
+- [Biome](https://biomejs.dev/en/reference/configuration/#javascriptformatterjsxquotestyle): A Rust-based linting and formatting tool that enhances the development experience.
+- [Ant Design](https://ant.design/components/overview-cn/): An out-of-the-box React component library, use version 5.x.
+- [vite-plugin-pages](https://github.com/hannoeru/vite-plugin-pages?tab=readme-ov-file#react-1): Provides a routing system based on conventions.
diff --git a/README.md b/README.md
index 21d6f8b..f326d09 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
 <!--   <h3>Farm-react Starter Template</h3> -->
   <p>
     <img src="./src/assets/logo.png" width="30" align="center" />
-    An out-of-the-box Farm-react development template
+    开箱即用的 `Farm-react-admin` 开发模板
   </p>
   <p align="center">
     <a href="https://discord.gg/mDErq9aFnF">
@@ -26,23 +26,23 @@
     <img src="https://github.com/jstors/assets/blob/main/home.jpeg" align="center" />
   </p>
 
-> For a better development experience, please install the [**Biome plugin**](https://biomejs.dev/en/reference/vscode/) on your local development tool.
+> 为获得更好的开发体验，请在本地开发工具上安装 [**Biome 插件**](https://biomejs.dev/en/reference/vscode/)。
 
 
 ## RoadMap
 
 [RoadMap](https://github.com/jstors/farm-react-template/issues/21)
 
-## Usage
+## 使用
 
-### User Configuration
+### 用户配置
 
-All configuration files are located in the `config` directory and can be modified according to your needs.
-- `config/const.ts`: Contains constants used in the project.
-- `config/menu.ts`: Menu configuration
+所有配置文件都位于 `config` 目录中，可以根据需要进行修改。
+- `config/const.ts`: 包含在项目中使用的常量
+- `config/menu.ts`: 菜单配置
 
 ## Integrated Features
-- [Farm](https://farm-fe.github.io/en/docs/quick-start): A Rust-based foundation framework that provides a complete development experience.
-- [Biome](https://biomejs.dev/en/reference/configuration/#javascriptformatterjsxquotestyle): A Rust-based linting and formatting tool that enhances the development experience.
-- [Ant Design](https://ant.design/components/overview-cn/): An out-of-the-box React component library, use version 5.x.
-- [vite-plugin-pages](https://github.com/hannoeru/vite-plugin-pages?tab=readme-ov-file#react-1): Provides a routing system based on conventions.
+- [Farm](https://farm-fe.github.io/en/docs/quick-start): 一个基于Rust的基础框架，提供完整的开发体验
+- [Biome](https://biomejs.dev/en/reference/configuration/#javascriptformatterjsxquotestyle): 一个基于Rust的代码检查和格式化工具，可以增强开发体验
+- [Ant Design](https://ant.design/components/overview-cn/): 开箱即用的 React 组件库，使用版本 5.x
+- [vite-plugin-pages](https://github.com/hannoeru/vite-plugin-pages?tab=readme-ov-file#react-1): 基于约定的路由系统