Skip to content

Commit 8aefb7d

Browse files
committed
docs: update README, README-zh-CN
1 parent 38b2e48 commit 8aefb7d

File tree

2 files changed

+42
-34
lines changed

2 files changed

+42
-34
lines changed

README-zh-CN.md

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,32 @@
11
# YukiHookAPI Project Builder
22

3-
![Blank](https://img.shields.io/badge/license-AGPL3.0-blue)
4-
![Blank](https://img.shields.io/badge/version-v1.0.4-green)
5-
[![Telegram](https://img.shields.io/badge/Follow-Telegram-blue.svg?logo=telegram)](https://t.me/YukiHookAPI)
6-
<br/><br/>
7-
<img src="https://github.com/fankes/YuKiHookAPI/blob/master/img-src/icon.png?raw=true" width = "100" height = "100"/>
8-
<br/>
9-
<br/>
3+
[![GitHub license](https://img.shields.io/github/license/fankes/YukiHookAPI-ProjectBuilder?color=blue)](https://github.com/fankes/YukiHookAPI-ProjectBuilder/blob/master/LICENSE)
4+
[![GitHub release](https://img.shields.io/github/v/release/fankes/YukiHookAPI-ProjectBuilder?display_name=release&logo=github&color=green)](https://github.com/fankes/YukiHookAPI-ProjectBuilder/releases)
5+
[![Telegram](https://img.shields.io/badge/discussion-Telegram-blue.svg?logo=telegram)](https://t.me/YukiHookAPI)
6+
[![Telegram](https://img.shields.io/badge/discussion%20dev-Telegram-blue.svg?logo=telegram)](https://t.me/HighCapable_Dev)
7+
8+
<img src="https://github.com/fankes/YuKiHookAPI/blob/master/img-src/icon.png?raw=true" width = "100" height = "100" alt="LOGO"/>
9+
1010
帮助你快速创建一个使用 YukiHookAPI 打造的 Xposed 项目模板。
11-
<br/>
1211

1312
[English](https://github.com/fankes/YukiHookAPI-ProjectBuilder/blob/master/README.md) | 简体中文
1413

1514
## 这是什么
1615

17-
- 这是一个使用 [YukiHookAPI](https://github.com/fankes/YukiHookAPI) 作为核心的 Xposed 模块自动构建工具
16+
这是一个使用 [YukiHookAPI](https://github.com/fankes/YukiHookAPI) 作为核心的 Xposed 模块自动构建工具
1817

19-
- 实现自动化搜索依赖快速搭建一个包含 Xposed 模块环境的 Android 项目模板
18+
实现自动化搜索依赖快速搭建一个包含 Xposed 模块环境的 Android 项目模板
2019

2120
## 如何使用
2221

23-
- 本项目使用 **Electron** 开发,快速实现多平台本地化应用程序的构建和运行
22+
本项目使用 **Electron** 开发,快速实现多平台本地化应用程序的构建和运行
2423

2524
你可以直接从 [Release](https://github.com/fankes/YukiHookAPI-ProjectBuilder/releases) 下载适合于你平台的应用程序。
2625

27-
**以下是手动部署与编译步骤**
26+
> 以下是手动部署与编译步骤
2827
2928
首先你需要安装 [node.js](https://nodejs.org/zh-cn/)
3029

31-
IDE 工具建议使用 **IntelliJ IDEA****WebStorm**
32-
33-
不建议使用 **Visual Studio Code** 对代码进行格式化,可能会造成一些错误。
34-
3530
- 执行如下命令安装 Electron
3631

3732
```
@@ -74,6 +69,16 @@ npm run make
7469
npm run package
7570
```
7671

72+
## 捐赠支持
73+
74+
工作不易,无意外情况此项目将继续维护下去,提供更多可能,欢迎打赏。
75+
76+
<img src="https://github.com/fankes/fankes/blob/main/img-src/payment_code.jpg?raw=true" width = "500" alt="Payment Code"/>
77+
78+
## Star History
79+
80+
![Star History Chart](https://api.star-history.com/svg?repos=fankes/YukiHookAPI-ProjectBuilder&type=Date)
81+
7782
## 许可证
7883

7984
- [AGPL-3.0](https://www.gnu.org/licenses/agpl-3.0.html)

README.md

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,50 @@
11
# YukiHookAPI Project Builder
22

3-
![Blank](https://img.shields.io/badge/license-AGPL3.0-blue)
4-
![Blank](https://img.shields.io/badge/version-v1.0.4-green)
5-
[![Telegram](https://img.shields.io/badge/Follow-Telegram-blue.svg?logo=telegram)](https://t.me/YukiHookAPI)
6-
<br/><br/>
7-
<img src="https://github.com/fankes/YuKiHookAPI/blob/master/img-src/icon.png?raw=true" width = "100" height = "100"/>
8-
<br/>
9-
<br/>
3+
[![GitHub license](https://img.shields.io/github/license/fankes/YukiHookAPI-ProjectBuilder?color=blue)](https://github.com/fankes/YukiHookAPI-ProjectBuilder/blob/master/LICENSE)
4+
[![GitHub release](https://img.shields.io/github/v/release/fankes/YukiHookAPI-ProjectBuilder?display_name=release&logo=github&color=green)](https://github.com/fankes/YukiHookAPI-ProjectBuilder/releases)
5+
[![Telegram](https://img.shields.io/badge/discussion-Telegram-blue.svg?logo=telegram)](https://t.me/YukiHookAPI)
6+
[![Telegram](https://img.shields.io/badge/discussion%20dev-Telegram-blue.svg?logo=telegram)](https://t.me/HighCapable_Dev)
7+
8+
<img src="https://github.com/fankes/YuKiHookAPI/blob/master/img-src/icon.png?raw=true" width = "100" height = "100" alt="LOGO"/>
9+
1010
A Xposed Project Builder by YukiHookAPI.
11-
<br/>
1211

1312
English | [简体中文](https://github.com/fankes/YukiHookAPI-ProjectBuilder/blob/master/README-zh-CN.md)
1413

1514
## What's this
1615

17-
- This is an automatic building tool for Xposed modules using [YukiHookAPI](https://github.com/fankes/YukiHookAPI) as the core
16+
This is an automatic building tool for Xposed Modules using [YukiHookAPI](https://github.com/fankes/YukiHookAPI) as the core.
1817

19-
- Implementing automated search relies on quickly building an Android project template that includes a Xposed module environment
18+
Implementing automated search relies on quickly building an Android project template that includes a Xposed Module environment.
2019

2120
## How to use
2221

23-
- This project is developed using **Electron** to quickly build and run multi-platform localized applications
22+
This project is developed using **Electron** to quickly build and run multi-platform localized applications.
2423

2524
You can download the application for your platform directly
2625
from [Release](https://github.com/fankes/YukiHookAPI-ProjectBuilder/releases).
2726

28-
**The following are the manual deployment and compilation steps**
27+
> The following are the manual deployment and compilation steps
2928
3029
First you need to install [node.js](https://nodejs.org/en/)
3130

32-
IDE tools recommend **IntelliJ IDEA** or **WebStorm**
31+
IDE tools recommend **IntelliJ IDEA** or **WebStorm**.
3332

3433
Formatting code with **Visual Studio Code** is not recommended and may cause some errors.
3534

36-
- Execute the following command to install Electron
35+
Execute the following command to install Electron.
3736

3837
```
3938
npm install --save-dev electron
4039
```
4140

42-
- Execute the following command to install yarn
41+
Execute the following command to install yarn.
4342

4443
```
4544
npm install yarn
4645
```
4746

48-
- Enter the project directory and execute the following command to install dependencies
47+
Enter the project directory and execute the following command to install dependencies.
4948

5049
```
5150
npm install --save-dev @electron-forge/cli
@@ -55,13 +54,13 @@ npm install --save-dev @electron-forge/cli
5554
npx electron-forge import
5655
```
5756

58-
- Use the following command to debug
57+
Use the following command to debug.
5958

6059
```
6160
npm run start
6261
```
6362

64-
- Use the following commands to compile & package
63+
Use the following commands to compile & package.
6564

6665
**Linux/macOS**
6766

@@ -75,6 +74,10 @@ npm run make
7574
npm run package
7675
```
7776

77+
## Star History
78+
79+
![Star History Chart](https://api.star-history.com/svg?repos=fankes/YukiHookAPI-ProjectBuilder&type=Date)
80+
7881
## License
7982

8083
- [AGPL-3.0](https://www.gnu.org/licenses/agpl-3.0.html)

0 commit comments

Comments
 (0)