docs: install description

chansee97 · Apr 22, 2024 · 5046531 · 5046531
1 parent d57c9c5
commit 5046531
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -47,14 +47,17 @@
 - [Gitee](https://gitee.com/chansee97/nova-admin)
 - [Github](https://github.com/chansee97/nova-admin)
 
-## Related projects
+## Interface document
 
-- [Nova-admin-nest](https://github.com/chansee97/nove-admin-nest) (under development) Nova-Admin supporting background project based on TS, NestJs, typeorm
+This project uses ApiFox for interface mock, check the online documentation for more interface details
+[online aipfox docs](https://apifox.com/apidoc/shared-2b1abeb5-6e78-425e-a4ff-d7277ae83bf0)
 
 ## Install and use
 
 The local development environment is recommended to use pnpm 8.x, Node.js must be version 20.x.
 
+It is recommended to directly download the compressed package from [Releases](https://github.com/chansee97/nova-admin/releases)
+
 ```bash
 # install dependencies
 pnpm i
@@ -67,10 +70,9 @@ pnpm build
 
 ```
 
-## Interface document
+## Related projects
 
-This project uses ApiFox for interface mock, check the online documentation for more interface details
-[online aipfox docs](https://apifox.com/apidoc/shared-2b1abeb5-6e78-425e-a4ff-d7277ae83bf0)
+- [Nova-admin-nest](https://github.com/chansee97/nove-admin-nest) (under development) Nova-Admin supporting background project based on TS, NestJs, typeorm
 
 ## Learn to communicate
 

diff --git a/README.zh-CN.md b/README.zh-CN.md
@@ -47,14 +47,17 @@
 - [Gitee](https://gitee.com/chansee97/nova-admin)
 - [Github](https://github.com/chansee97/nova-admin)
 
-## 相关项目
+## 接口文档
 
-- [Nova-admin-nest](https://github.com/chansee97/nove-admin-nest) (开发中)基于TS, NestJs, typeorm的Nova-Admin配套后台项目
+本项目使用ApiFox进行接口mock，查看在线文档以了解更多接口详情
+[在线apifox文档](https://apifox.com/apidoc/shared-2b1abeb5-6e78-425e-a4ff-d7277ae83bf0)
 
 ## 安装使用
 
 本地开发环境建议使用 pnpm 8.x 、Node.js 必须 20.x
 
+推荐直接下载[Releases](https://github.com/chansee97/nova-admin/releases)压缩包
+
 ```bash
 # install dependencies
 pnpm i
@@ -67,10 +70,9 @@ pnpm build
 
 ```
 
-## 接口文档
+## 相关项目
 
-本项目使用ApiFox进行接口mock，查看在线文档以了解更多接口详情
-[在线apifox文档](https://apifox.com/apidoc/shared-2b1abeb5-6e78-425e-a4ff-d7277ae83bf0)
+- [Nova-admin-nest](https://github.com/chansee97/nove-admin-nest) (开发中)基于TS, NestJs, typeorm的Nova-Admin配套后台项目
 
 ## 学习交流