Skip to content

Commit c247dcd

Browse files
committed
⚡ feat: update README.md
1 parent 9feceed commit c247dcd

File tree

2 files changed

+30
-26
lines changed

2 files changed

+30
-26
lines changed

README-zh.md

+15-13
Original file line numberDiff line numberDiff line change
@@ -21,27 +21,27 @@
2121

2222

2323

24-
## 前序准备
24+
## 🎯 前序准备
2525

2626
请确保安装了 [Node.js](https://nodejs.org/)(>= 10.18.1)
2727

28-
## 特性
28+
## 特性
2929

30-
🌌 解耦了业务层和控制层
30+
* 🌈 解耦了业务层和控制层
3131

32-
🐣 可能是 Puppeteer 项目的最佳实践
32+
* 🛡 可能是 Puppeteer 项目的最佳实践
3333

34-
🧩 可配置的路由
34+
* 🧩 可配置的路由
3535

36-
🚧 内置 Eslint 语法风格检查
36+
* 🚧 内置 Eslint 语法风格检查
3737

38-
⚡ 使用 Rollup 快速构建
38+
* ⚡ 使用 Rollup 快速构建
3939

40-
🕊 内置了 PDF 水印、页眉和页脚,可自行修改及扩展
40+
* 🔌 内置了 PDF 水印、页眉和页脚,可自行修改及扩展
4141

42-
🧲 支持合并多个 PDF 文件
42+
* 🧲 支持合并多个 PDF 文件
4343

44-
🔥 支持开发环境下的模块热更新
44+
* 🔥 支持开发环境下的模块热更新
4545

4646
## 项目结构
4747

@@ -54,19 +54,21 @@
5454
│ └── routes.ts --- 用于配置路由元信息 <a href="#路由配置">👉 路由配置</a>
5555
</pre>
5656

57-
## 安装
57+
## ⚡ 快速开始
58+
59+
### 1. 安装
5860

5961
```bash
6062
pnpm install
6163
```
6264

63-
## 开发环境运行
65+
### 2. 开发环境运行
6466

6567
```bash
6668
pnpm dev
6769
```
6870

69-
## 生产环境运行
71+
### 3. 生产环境运行
7072

7173
该项目已内置 `pm2`,在构建完毕后运行 `pnpm start` 即可使用 `pm2` 管理进程。
7274

README.md

+15-13
Original file line numberDiff line numberDiff line change
@@ -21,27 +21,27 @@ English | [中文](README-zh.md)
2121

2222

2323

24-
## Prerequisites
24+
## 🎯 Prerequisites
2525

2626
Please make sure that [Node.js](https://nodejs.org/) (>= 10.18.1) is installed on your operating system.
2727

28-
## Feature
28+
## ✨ Features
2929

30-
🌌 Separation business logic and Controllers.
30+
* 🌈 Separation business logic and Controllers.
3131

32-
🐣 Probably the best practice for Puppeteer project.
32+
* 🛡 Probably the best practice for Puppeteer project.
3333

34-
🧩 Configured routing.
34+
* 🧩 Configured routing.
3535

36-
🚧 Eslint configuration.
36+
* 🚧 Eslint configuration.
3737

38-
⚡ Fast build with Rollup.
38+
* ⚡ Fast build with Rollup.
3939

40-
🕊 Extensible PDF watermark, header and footer.
40+
* 🔌 Extensible PDF watermark, header and footer.
4141

42-
🧲 Supports merging of multiple PDF files.
42+
* 🧲 Supports merging of multiple PDF files.
4343

44-
🔥 HMR.
44+
* 🔥 HMR.
4545

4646
## Project structure
4747

@@ -54,19 +54,21 @@ Please make sure that [Node.js](https://nodejs.org/) (>= 10.18.1) is installed o
5454
│ └── routes.ts --- Configs for routing controllers <a href="#Routing">👉 Routing</a>
5555
</pre>
5656

57-
## Installation
57+
## ⚡ Quick Start
58+
59+
### 1. Installation
5860

5961
```bash
6062
pnpm install
6163
```
6264

63-
## Running Development
65+
### 2. Running Development
6466

6567
```bash
6668
pnpm dev
6769
```
6870

69-
## Running Production
71+
### 3. Running Production
7072

7173
The project has built-in a `pm2`, running the `pnpm start` will automatically manage the process by `pm2`.
7274

0 commit comments

Comments
 (0)