Skip to content

Commit 9131a09

Browse files
committed
Improve documentation.
1 parent b0310cd commit 9131a09

File tree

9 files changed

+78
-70
lines changed

9 files changed

+78
-70
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ body:
1515
1616
- type: input
1717
attributes:
18-
label: shadowhook Version
18+
label: ShadowHook Version
1919
placeholder: "1.0.0"
2020
validations:
2121
required: true

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Contributing to shadowhook
1+
# Contributing to ShadowHook
22

3-
Welcome to the shadowhook project. Read on to learn more about our development process and how to propose bug fixes and improvements.
3+
Welcome to the ShadowHook project. Read on to learn more about our development process and how to propose bug fixes and improvements.
44

55
## Issues
66

@@ -46,4 +46,4 @@ Please make sure the following is done when submitting a pull request:
4646

4747
## License
4848

49-
By contributing to shadowhook, you agree that your contributions will be licensed under its [MIT LICENSE](LICENSE).
49+
By contributing to ShadowHook, you agree that your contributions will be licensed under its [MIT LICENSE](LICENSE).

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# shadowhook
1+
# ShadowHook
22

33
![](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)
44
![](https://img.shields.io/badge/release-1.0.3-red.svg?style=flat)
@@ -7,7 +7,9 @@
77

88
[README 中文版](README.zh-CN.md)
99

10-
**shadowhook** is an Android inline hook library which supports thumb, arm32 and arm64.
10+
**ShadowHook** is an Android inline hook library which supports thumb, arm32 and arm64.
11+
12+
If you need an Android PLT hook library, please move to [ByteHook](https://github.com/bytedance/bhook).
1113

1214

1315
## Features
@@ -26,7 +28,7 @@
2628

2729
## Documentation
2830

29-
[shadowhook Manual](doc/manual.md)
31+
[ShadowHook Manual](doc/manual.md)
3032

3133

3234
## Quick Start
@@ -35,7 +37,7 @@ You can refer to the sample app in [app module](app), or refer to the hook/unhoo
3537

3638
### 1. Add dependency in build.gradle
3739

38-
shadowhook is published on [Maven Central](https://search.maven.org/), and uses [Prefab](https://google.github.io/prefab/) package format for [native dependencies](https://developer.android.com/studio/build/native-dependencies), which is supported by [Android Gradle Plugin 4.0+](https://developer.android.com/studio/releases/gradle-plugin?buildsystem=cmake#native-dependencies).
40+
ShadowHook is published on [Maven Central](https://search.maven.org/), and uses [Prefab](https://google.github.io/prefab/) package format for [native dependencies](https://developer.android.com/studio/build/native-dependencies), which is supported by [Android Gradle Plugin 4.0+](https://developer.android.com/studio/releases/gradle-plugin?buildsystem=cmake#native-dependencies).
3941

4042
```Gradle
4143
allprojects {
@@ -57,7 +59,7 @@ dependencies {
5759
}
5860
```
5961

60-
**Note**: shadowhook uses the [prefab package schema v2](https://github.com/google/prefab/releases/tag/v2.0.0), which is configured by default since [Android Gradle Plugin 7.1.0](https://developer.android.com/studio/releases/gradle-plugin?buildsystem=cmake#7-1-0). If you are using Android Gradle Plugin earlier than 7.1.0, please add the following configuration to `gradle.properties`:
62+
**Note**: ShadowHook uses the [prefab package schema v2](https://github.com/google/prefab/releases/tag/v2.0.0), which is configured by default since [Android Gradle Plugin 7.1.0](https://developer.android.com/studio/releases/gradle-plugin?buildsystem=cmake#7-1-0). If you are using Android Gradle Plugin earlier than 7.1.0, please add the following configuration to `gradle.properties`:
6163

6264
```
6365
android.prefabVersion=2.0.0
@@ -100,7 +102,7 @@ android {
100102

101103
### 4. Add packaging options
102104

103-
If you are using shadowhook in an SDK project, you may need to avoid packaging libshadowhook.so into your AAR, so as not to encounter duplicate libshadowhook.so file when packaging the app project.
105+
If you are using ShadowHook in an SDK project, you may need to avoid packaging libshadowhook.so into your AAR, so as not to encounter duplicate libshadowhook.so file when packaging the app project.
104106

105107
```Gradle
106108
android {
@@ -110,7 +112,7 @@ android {
110112
}
111113
```
112114

113-
On the other hand, if you are using shadowhook in an APP project, you may need to add some options to deal with conflicts caused by duplicate libshadowhook.so file.
115+
On the other hand, if you are using ShadowHook in an APP project, you may need to add some options to deal with conflicts caused by duplicate libshadowhook.so file.
114116

115117
```Gradle
116118
android {
@@ -122,7 +124,7 @@ android {
122124

123125
### 5. Initialize
124126

125-
shadowhook supports two modes (shared mode and unique mode). The proxy function in the two modes is written slightly differently. You can try the unique mode first.
127+
ShadowHook supports two modes (shared mode and unique mode). The proxy function in the two modes is written slightly differently. You can try the unique mode first.
126128

127129
```Java
128130
import com.bytedance.shadowhook.ShadowHook;
@@ -228,9 +230,9 @@ void do_unhook()
228230

229231
## License
230232

231-
shadowhook is licensed by [MIT License](LICENSE).
233+
ShadowHook is licensed by [MIT License](LICENSE).
232234

233-
shadowhook uses the following third-party source code or libraries:
235+
ShadowHook uses the following third-party source code or libraries:
234236

235237
* [queue.h](shadowhook/src/main/cpp/third_party/bsd/queue.h)
236238
BSD 3-Clause License

README.zh-CN.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# shadowhook
1+
# ShadowHook
22

33
![](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)
44
![](https://img.shields.io/badge/release-1.0.3-red.svg?style=flat)
@@ -7,7 +7,9 @@
77

88
[README English Version](README.md)
99

10-
**shadowhook** 是一个 Android inline hook 库,它支持 thumb、arm32 和 arm64。
10+
**ShadowHook** 是一个 Android inline hook 库,它支持 thumb、arm32 和 arm64。
11+
12+
如果你需要的是 Android PLT hook 库,请移步到 [ByteHook](https://github.com/bytedance/bhook)
1113

1214

1315
## 特征
@@ -26,7 +28,7 @@
2628

2729
## 文档
2830

29-
[shadowhook 手册](doc/manual.zh-CN.md)
31+
[ShadowHook 手册](doc/manual.zh-CN.md)
3032

3133

3234
## 快速开始
@@ -35,7 +37,7 @@
3537

3638
### 1. 在 build.gradle 中增加依赖
3739

38-
shadowhook 发布在 [Maven Central](https://search.maven.org/) 上。为了使用 [native 依赖项](https://developer.android.com/studio/build/native-dependencies)shadowhook 使用了从 [Android Gradle Plugin 4.0+](https://developer.android.com/studio/releases/gradle-plugin?buildsystem=cmake#native-dependencies) 开始支持的 [Prefab](https://google.github.io/prefab/) 包格式。
40+
ShadowHook 发布在 [Maven Central](https://search.maven.org/) 上。为了使用 [native 依赖项](https://developer.android.com/studio/build/native-dependencies)ShadowHook 使用了从 [Android Gradle Plugin 4.0+](https://developer.android.com/studio/releases/gradle-plugin?buildsystem=cmake#native-dependencies) 开始支持的 [Prefab](https://google.github.io/prefab/) 包格式。
3941

4042
```Gradle
4143
allprojects {
@@ -57,7 +59,7 @@ dependencies {
5759
}
5860
```
5961

60-
**注意**shadowhook 使用 [prefab package schema v2](https://github.com/google/prefab/releases/tag/v2.0.0),它是从 [Android Gradle Plugin 7.1.0](https://developer.android.com/studio/releases/gradle-plugin?buildsystem=cmake#7-1-0) 开始作为默认配置的。如果你使用的是 Android Gradle Plugin 7.1.0 之前的版本,请在 `gradle.properties` 中加入以下配置:
62+
**注意**ShadowHook 使用 [prefab package schema v2](https://github.com/google/prefab/releases/tag/v2.0.0),它是从 [Android Gradle Plugin 7.1.0](https://developer.android.com/studio/releases/gradle-plugin?buildsystem=cmake#7-1-0) 开始作为默认配置的。如果你使用的是 Android Gradle Plugin 7.1.0 之前的版本,请在 `gradle.properties` 中加入以下配置:
6163

6264
```
6365
android.prefabVersion=2.0.0
@@ -100,7 +102,7 @@ android {
100102

101103
### 4. 增加打包选项
102104

103-
如果你是在一个 SDK 工程里使用 shadowhook,你可能需要避免把 libshadowhook.so 打包到你的 AAR 里,以免 app 工程打包时遇到重复的 libshadowhook.so 文件。
105+
如果你是在一个 SDK 工程里使用 ShadowHook,你可能需要避免把 libshadowhook.so 打包到你的 AAR 里,以免 app 工程打包时遇到重复的 libshadowhook.so 文件。
104106

105107
```Gradle
106108
android {
@@ -110,7 +112,7 @@ android {
110112
}
111113
```
112114

113-
另一方面, 如果你是在一个 APP 工程里使用 shadowhook,你可以需要增加一些选项,用来处理重复的 libshadowhook.so 文件引起的冲突。
115+
另一方面, 如果你是在一个 APP 工程里使用 ShadowHook,你可以需要增加一些选项,用来处理重复的 libshadowhook.so 文件引起的冲突。
114116

115117
```Gradle
116118
android {
@@ -122,7 +124,7 @@ android {
122124

123125
### 5. 初始化
124126

125-
shadowhook 支持两种模式(shared 模式和 unique 模式),两种模式下的 proxy 函数写法稍有不同,你可以先尝试一下 unique 模式。
127+
ShadowHook 支持两种模式(shared 模式和 unique 模式),两种模式下的 proxy 函数写法稍有不同,你可以先尝试一下 unique 模式。
126128

127129
```Java
128130
import com.bytedance.shadowhook.ShadowHook;
@@ -228,9 +230,9 @@ void do_unhook()
228230

229231
## 许可证
230232

231-
shadowhook 使用 [MIT 许可证](LICENSE) 授权。
233+
ShadowHook 使用 [MIT 许可证](LICENSE) 授权。
232234

233-
shadowhook 使用了以下第三方源码或库:
235+
ShadowHook 使用了以下第三方源码或库:
234236

235237
* [queue.h](shadowhook/src/main/cpp/third_party/bsd/queue.h)
236238
BSD 3-Clause License

SECURITY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Reporting Security vulnerabilities
22

3-
The shadowhook team and community take security bugs in shadowhook seriously. We appreciate your efforts to responsibly disclose your findings, and will make every effort to acknowledge your contributions.
3+
The ShadowHook team and community take security bugs in ShadowHook seriously. We appreciate your efforts to responsibly disclose your findings, and will make every effort to acknowledge your contributions.
44

55
**Please do not report security vulnerabilities through GitHub issues, discussions or pull requests. This makes the problem immediately visible to everyone, including malicious actors.**
66

77
Instead, please send email to <caikelun@bytedance.com>. If possible, encrypt your message with [this PGP key](https://raw.githubusercontent.com/caikelun/caikelun.github.io/master/site/pgp-public-key.txt).
88

9-
The shadowhook team will send a response indicating the next steps in handling your report. After the initial reply to your report, the security team will keep you informed of the progress towards a fix and full announcement, and may ask for additional information or guidance.
9+
The ShadowHook team will send a response indicating the next steps in handling your report. After the initial reply to your report, the security team will keep you informed of the progress towards a fix and full announcement, and may ask for additional information or guidance.

build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ ext {
2525
POM_VERSION_NAME = "1.0.3"
2626

2727
POM_NAME = "shadowhook"
28-
POM_DESCRIPTION = "shadowhook is an inline hook library for Android apps."
28+
POM_DESCRIPTION = "ShadowHook is an Android inline hook library which supports thumb, arm32 and arm64."
2929
POM_URL = "https://github.com/bytedance/android-inline-hook"
3030
POM_INCEPTION_YEAR = "2021"
3131
POM_PACKAGING = "aar"

doc/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# shadowhook Documentation
1+
# ShadowHook Documentation
22

33
## Manual
44

5-
[shadowhook Manual - English version](manual.md)
5+
[ShadowHook Manual - English version](manual.md)
66

7-
[shadowhook 手册 - 中文版](manual.zh-CN.md)
7+
[ShadowHook 手册 - 中文版](manual.zh-CN.md)

0 commit comments

Comments
 (0)