docs: update readme doc

fecommunity · fecommunity · commit a6a7d2107cca · 2024-09-24T23:44:23.000+08:00
diff --git a/README-en_US.md b/README-en_US.md
@@ -0,0 +1,86 @@
+<div align="center"><a name="readme-top"></a>
+
+<a href="https://gaoredu.com" title="高热度网"><img height="180" src="https://www.gaoredu.com/wp-content/uploads/2023/10/logo.png"></a>
+
+<h1>Easy-Blog</h1>
+
+Easy-Blog is a very easy blog system that integrates article publishing, page creation, knowledge management, blog management and other functions.
+
+[![GitHub license](https://img.shields.io/badge/license-Apache-blue.svg)](https://github.com/fecommunity/easy-blog/blob/master/LICENSE)[![(Runtime) Build and Test](https://github.com/facebook/react/actions/workflows/runtime_build_and_test.yml/badge.svg)](https://github.com/fecommunity/easy-blog/blob/master/package.json) [![(Compiler) TypeScript](https://github.com/facebook/react/actions/workflows/compiler_typescript.yml/badge.svg?branch=main)](https://github.com/fecommunity/easy-blog/blob/master/client/tsconfig.json) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/fecommunity/easy-blog/pulls)
+
+[Issues](https://github.com/fecommunity/easy-blog/issues) · [Pull Request](https://github.com/fecommunity/easy-blog/pulls) · English · [中文](./README.md)
+</div>
+
+Light Theme
+[![Home-Light Theme](./public/en-home-light.png)](https://gaoredu.com)
+
+Dark Theme
+[![Home-Dark Theme](./public/en-home-dark.png)](https://gaoredu.com)
+
+Blog Reading
+[![Blog Management](./public/en-reading.png)](https://gaoredu.com)
+
+## ✨ Features
+
+-  📦  Technology Stack: Built on React+MySQL+NestJS+NextJS
+-  🌈  Componentization: an interactive language and visual style based on antd
+-  🌍  Internationalization: Supports switching between Chinese and English, with international configuration management capabilities
+-  🌞  Black and White Theme: Supports free switching between light and dark mode themes
+-  🖌️  Creation Management: Built in 'MarkDown' editor, supporting article writing, category and directory management, and tag management
+-  📃  Page management: supports customizing new pages
+-  💬  Comment management: supports content comment management
+-  📷 Media Management: Supports local file upload and OSS file upload
+- ...
+
+## ⌨️ Development
+
+### Environment
+```bash
+$ git clone --depth=1 https://github.com/fecommnity/easy-blog.git
+$ cd easy-blog
+$ npm i -g pnpm
+$ pnpm i
+```
+
+### Configuration
+
+After the project starts, the `. env ` configuration file in the root directory will be loaded. Please ensure that the MySQL database service is consistent with the following configuration, and create the ` easy-blog ` database in advance
+
+```js
+DB_HOST=127.0.0.1 // Default Database Host
+DB_PORT=3306 // Default Database Port
+DB_USER=admin // Default Username
+DB_PASSWD=admin // Default Password
+DB_DATABASE=easy_blog // Default Database Name
+```
+
+After the environment is ready, execute the startup shell:
+
+```bash
+$ pnpm run dev
+```
+
+Open your browser and visit http://127.0.0.1:3001
+
+
+## 🔗 Links
+
+- [Home](https://github.com/fecommunity/easy-blog)
+- [Easy Blog](https://gaoredu.com)
+- [Issues](https://github.com/fecommunity/easy-blog/issues)
+- [Pull Request](https://github.com/fecommunity/easy-blog/pulls) 
+- [next.js](https://github.com/vercel/next.js)
+- [nest.js](https://github.com/nestjs/nest)
+
+
+
+## 👥 Contributing
+
+We warmly invite contributions from everyone. Before you get started, please take a moment to review our [Contributing Guide](https://ant.design/docs/react/contributing). Feel free to share your ideas through [Pull Requests](https://github.com/ant-design/ant-design/pulls) or [GitHub Issues](https://github.com/ant-design/ant-design/issues). If you're interested in enhancing our codebase, explore the [Development Instructions](https://github.com/ant-design/ant-design/wiki/Development) and enjoy your coding journey! :)
+
+1. [GitHub Discussions](https://github.com/ant-design/ant-design/discussions)
+2. [Stack Overflow](http://stackoverflow.com/questions/tagged/antd)（English）
+3. [Segment Fault](https://segmentfault.com/t/antd)（Chinese）
+
+
+You can also send me an email: admin@gaoredu.com
diff --git a/README-zh_CN.md b/README-zh_CN.md
diff --git a/README.md b/README.md
@@ -4,83 +4,93 @@
 
 <h1>Easy-Blog</h1>
 
-Easy-Blog is a very easy blog system that integrates article publishing, page creation, knowledge management, blog management and other functions.
+Easy-Blog 是一套集成文章发表、页面创建、知识库管理、博客后台管理等功能于一体的博客系统。
 
 [![GitHub license](https://img.shields.io/badge/license-Apache-blue.svg)](https://github.com/fecommunity/easy-blog/blob/master/LICENSE)[![(Runtime) Build and Test](https://github.com/facebook/react/actions/workflows/runtime_build_and_test.yml/badge.svg)](https://github.com/fecommunity/easy-blog/blob/master/package.json) [![(Compiler) TypeScript](https://github.com/facebook/react/actions/workflows/compiler_typescript.yml/badge.svg?branch=main)](https://github.com/fecommunity/easy-blog/blob/master/client/tsconfig.json) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/fecommunity/easy-blog/pulls)
 
-[Issues](https://github.com/fecommunity/easy-blog/issues) · [Pull Request](https://github.com/fecommunity/easy-blog/pulls) · English · [中文](./README-zh_CN.md)
+[报告问题](https://github.com/fecommunity/easy-blog/issues) · [参与共建](https://github.com/fecommunity/easy-blog/pulls) · [English](./README-en_US.md) · 中文
 </div>
 
-Light Theme
-[![Home-Light Theme](./public/en-home-light.png)](https://gaoredu.com)
+首页-浅色主题
+[![首页-浅色主题](./public/light.png)](https://gaoredu.com)
 
-Dark Theme
-[![Home-Dark Theme](./public/en-home-dark.png)](https://gaoredu.com)
+首页-暗黑主题
+[![首页-暗黑主题](./public/dark.png)](https://gaoredu.com)
 
-Blog Reading
-[![Blog Management](./public/en-reading.png)](https://gaoredu.com)
+后台管理
+[![后台管理](./public/admin.png)](https://gaoredu.com)
 
-## ✨ Features
+## ✨ 特性
 
--  📦  Technology Stack: Built on React+MySQL+NestJS+NextJS
--  🌈  Componentization: an interactive language and visual style based on antd
--  🌍  Internationalization: Supports switching between Chinese and English, with international configuration management capabilities
--  🌞  Black and White Theme: Supports free switching between light and dark mode themes
--  🖌️  Creation Management: Built in 'MarkDown' editor, supporting article writing, category and directory management, and tag management
--  📃  Page management: supports customizing new pages
--  💬  Comment management: supports content comment management
--  📷 Media Management: Supports local file upload and OSS file upload
+- 📦 技术栈：基于 `React` + `MySQL` + `NestJS` + `NextJS` 构建
+- 🌈 组件化：基于 `antd` 的交互语言和视觉风格
+- 🌍 国际化：支持中英文切换，国际化配置管理能力
+- 🌞 黑白主题：支持亮色和暗黑模式主题自由切换
+- 🖌️ 创作管理：内置 `MarkDown` 编辑器，支持文章写文章、分类目录管理，标签管理
+- 📃 页面管理：支持自定义新页面
+- 💬 评论管理：支持内容评论管理
+- 📷️ 媒体管理：支持文件本地上传和 `OSS` 文件上传
 - ...
 
-## ⌨️ Development
+## ⌨️ 本地开发
 
-### Environment
+### 环境准备
 ```bash
 $ git clone --depth=1 https://github.com/fecommnity/easy-blog.git
 $ cd easy-blog
 $ npm i -g pnpm
 $ pnpm i
 ```
 
-### Configuration
+### 配置文件
 
-After the project starts, the `. env ` configuration file in the root directory will be loaded. Please ensure that the MySQL database service is consistent with the following configuration, and create the ` easy-blog ` database in advance
+项目启动后会加载根目录下的 `.env` 配置文件，请确保MySQL数据库服务和下面的配置保持一致，并提前创建好 `easy_blog` 数据库
 
 ```js
-DB_HOST=127.0.0.1 // Default Database Host
-DB_PORT=3306 // Default Database Port
-DB_USER=admin // Default Username
-DB_PASSWD=admin // Default Password
-DB_DATABASE=easy_blog // Default Database Name
+DB_HOST=127.0.0.1 // 数据库地址
+DB_PORT=3306 // 端口
+DB_USER=admin // 用户名
+DB_PASSWD=admin // 密码
+DB_DATABASE=easy_blog // 数据库
 ```
 
-After the environment is ready, execute the startup shell:
+环境准备好后，执行启动命令：
 
 ```bash
 $ pnpm run dev
 ```
 
-Open your browser and visit http://127.0.0.1:3001
+打开浏览器访问 http://127.0.0.1:3001
 
 
-## 🔗 Links
+## 🔗 链接
 
-- [Home](https://github.com/fecommunity/easy-blog)
-- [Easy Blog](https://gaoredu.com)
-- [Issues](https://github.com/fecommunity/easy-blog/issues)
-- [Pull Request](https://github.com/fecommunity/easy-blog/pulls) 
-- [next.js](https://github.com/vercel/next.js)
-- [nest.js](https://github.com/nestjs/nest)
+- [首页](https://github.com/fecommunity/easy-blog)
+- [高热度网](https://gaoredu.com)
+- [报告问题](https://github.com/fecommunity/easy-blog/issues)
+- [参与共建](https://github.com/fecommunity/easy-blog/pulls) 
+- [next.js 源码](https://github.com/vercel/next.js)
+- [nest.js 源码](https://github.com/nestjs/nest)
 
 
+> 强烈推荐阅读 [《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way)、[《如何向开源社区提问题》](https://github.com/seajs/seajs/issues/545) 和 [《如何有效地报告 Bug》](http://www.chiark.greenend.org.uk/%7Esgtatham/bugs-cn.html)、[《如何向开源项目提交无法解答的问题》](https://zhuanlan.zhihu.com/p/25795393)，更好的问题更容易获得帮助。
 
-## 👥 Contributing
+## 👥 社区互助
 
-We warmly invite contributions from everyone. Before you get started, please take a moment to review our [Contributing Guide](https://ant.design/docs/react/contributing). Feel free to share your ideas through [Pull Requests](https://github.com/ant-design/ant-design/pulls) or [GitHub Issues](https://github.com/ant-design/ant-design/issues). If you're interested in enhancing our codebase, explore the [Development Instructions](https://github.com/ant-design/ant-design/wiki/Development) and enjoy your coding journey! :)
+如果您在使用的过程中碰到问题，可以通过下面几个途径寻求帮助，同时我们也鼓励资深用户通过下面的途径给新人提供帮助。
+<div>
+<a href="https://gaoredu.com" title="高热度网"><img height="200" src="https://www.gaoredu.com/wp-content/uploads/2024/08/WechatIMG23.jpg"></a>
+</div>
 
-1. [GitHub Discussions](https://github.com/ant-design/ant-design/discussions)
-2. [Stack Overflow](http://stackoverflow.com/questions/tagged/antd)（English）
-3. [Segment Fault](https://segmentfault.com/t/antd)（Chinese）
+通过 WeChat 联系，可通过搜素微信号 `red_tea_v2` 或扫码加入 ，并备注来源。
+
+通过 GitHub Discussions 提问时，建议使用 `Q&A` 标签。
 
+通过 Stack Overflow 或者 Segment Fault 提问时，建议加上 `easy-blog` 标签。
+
+
+1. [GitHub Discussions](https://github.com/ant-design/ant-design/discussions)
+2. [Stack Overflow](http://stackoverflow.com/questions/tagged/antd)（英文）
+3. [Segment Fault](https://segmentfault.com/t/antd)（中文）
 
-You can also send me an email: admin@gaoredu.com
+Email: admin@gaoredu.com
