Add documentation.

Author: caikelun

CONTRIBUTING.md

@@ -1,6 +1,6 @@
-# Contributing to bhook
+# Contributing to ByteHook
 
-Welcome to the bhook project. Read on to learn more about our development process and how to propose bug fixes and improvements.
+Welcome to the ByteHook project. Read on to learn more about our development process and how to propose bug fixes and improvements.
 
 ## Issues
 
@@ -44,4 +44,4 @@ Please make sure the following is done when submitting a pull request:
 
 ## License
 
-By contributing to bhook, you agree that your contributions will be licensed under its [MIT LICENSE](LICENSE).
+By contributing to ByteHook, you agree that your contributions will be licensed under its [MIT LICENSE](LICENSE).

README.md

@@ -1,4 +1,4 @@
-# bhook
+# ByteHook
 
 ![](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)
 ![](https://img.shields.io/badge/release-1.0.1-red.svg?style=flat)
@@ -7,9 +7,9 @@
 
 [README 中文版](README.zh-CN.md)
 
-bhook(aka ByteHook) is a PLT hook framework for Android app.
+ByteHook is a PLT hook framework for Android app.
 
-Most of ByteDance's Android apps use bhook as the PLT hook solution online.
+Most of ByteDance's Android apps use ByteHook as the PLT hook solution online.
 
 
 ## Features
@@ -28,7 +28,7 @@ Most of ByteDance's Android apps use bhook as the PLT hook solution online.
 
 ### 1. Add dependency in build.gradle
 
-bhook 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).
+ByteHook 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).
 
 ```Gradle
 allprojects {
@@ -87,7 +87,7 @@ android {
 
 ### 4. Add packaging options
 
-If you are using bhook in an SDK project, you may need to avoid packaging libbytehook.so into your AAR, so as not to encounter duplicate libbytehook.so file when packaging the app project.
+If you are using ByteHook in an SDK project, you may need to avoid packaging libbytehook.so into your AAR, so as not to encounter duplicate libbytehook.so file when packaging the app project.
 
 ```Gradle
 android {
@@ -97,7 +97,7 @@ android {
 }
 ```
 
-On the other hand, if you are using bhook in an APP project, you may need to add some options to deal with conflicts caused by duplicate libbytehook.so file.
+On the other hand, if you are using ByteHook in an APP project, you may need to add some options to deal with conflicts caused by duplicate libbytehook.so file.
 
 ```Gradle
 android {
@@ -158,11 +158,15 @@ These three hook functions are used to hook single, partial, and all caller dyna
 Notice:
 * If you need to call the original function in the proxy function, please always use the `BYTEHOOK_CALL_PREV()` macro.
 * Make sure to call `BYTEHOOK_POP_STACK()` macro before proxy function returning. In the CPP source file, you can also call `BYTEHOOK_STACK_SCOPE()` macro at the beginning of the proxy function instead.
-* bhook proxies `dlopen()` and `android_dlopen_ext()` internally, so please do not try to hook these two functions. If you want to monitor the loading of ELF, please use `bytehook_add_dlopen_callback()` and `bytehook_del_dlopen_callback()`.
 
 There is a sample app in the [bytehook-sample](bytehook_sample) folder you can refer to.
 
 
+## Documentation
+
+[Documentation](doc)
+
+
 ## Contributing
 
 [Contributing Guide](CONTRIBUTING.md)

README.zh-CN.md

@@ -1,4 +1,4 @@
-# bhook
+# ByteHook
 
 ![](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)
 ![](https://img.shields.io/badge/release-1.0.1-red.svg?style=flat)
@@ -7,9 +7,9 @@
 
 [README English Version](README.md)
 
-bhook(aka ByteHook) 是一个针对 Android app 的 PLT hook 框架。
+ByteHook 是一个针对 Android app 的 PLT hook 框架。
 
-字节跳动的大多数 Android app 在线上使用了 bhook 作为 PLT hook 方案。
+字节跳动的大多数 Android app 在线上使用了 ByteHook 作为 PLT hook 方案。
 
 
 ## 特征
@@ -28,7 +28,7 @@ bhook(aka ByteHook) 是一个针对 Android app 的 PLT hook 框架。
 
 ### 1. 在 build.gradle 中增加依赖
 
-bhook 发布在 [Maven Central](https://search.maven.org/) 上。为了使用 [native 依赖项](https://developer.android.com/studio/build/native-dependencies)，xDL 使用了从 [Android Gradle Plugin 4.0+](https://developer.android.com/studio/releases/gradle-plugin?buildsystem=cmake#native-dependencies) 开始支持的 [Prefab](https://google.github.io/prefab/) 包格式。
+ByteHook 发布在 [Maven Central](https://search.maven.org/) 上。为了使用 [native 依赖项](https://developer.android.com/studio/build/native-dependencies)，ByteHook 使用了从 [Android Gradle Plugin 4.0+](https://developer.android.com/studio/releases/gradle-plugin?buildsystem=cmake#native-dependencies) 开始支持的 [Prefab](https://google.github.io/prefab/) 包格式。
 
 ```Gradle
 allprojects {
@@ -87,7 +87,7 @@ android {
 
 ### 4. 增加打包选项
 
-如果你是在一个 SDK 工程里使用 bhook，你可能需要避免把 libbytehook.so 打包到你的 AAR 里，以免 app 工程打包时遇到重复的 libbytehook.so 文件。
+如果你是在一个 SDK 工程里使用 ByteHook，你可能需要避免把 libbytehook.so 打包到你的 AAR 里，以免 app 工程打包时遇到重复的 libbytehook.so 文件。
 
 ```Gradle
 android {
@@ -97,7 +97,7 @@ android {
 }
 ```
 
-另一方面, 如果你是在一个 APP 工程里使用 bhook，你可以需要增加一些选项，用来处理重复的 libbytehook.so 文件引起的冲突。
+另一方面, 如果你是在一个 APP 工程里使用 ByteHook，你可以需要增加一些选项，用来处理重复的 libbytehook.so 文件引起的冲突。
 
 ```Gradle
 android {
@@ -158,11 +158,15 @@ int bytehook_unhook(bytehook_stub_t stub);
 注意：
 * 如果需要在代理函数中调用原函数，请始终使用 `BYTEHOOK_CALL_PREV()` 宏来完成。
 * 确保在代理函数返回前调用 `BYTEHOOK_POP_STACK()` 宏。在 CPP 源文件中，也可以改为在代理函数的开头调用 `BYTEHOOK_STACK_SCOPE()` 宏。
-* bhook 在内部代理了 `dlopen()` 和 `android_dlopen_ext()`，所以请不要试图 hook 这两个函数。如果想监控 ELF 的加载，请使用 `bytehook_add_dlopen_callback()` 和 `bytehook_del_dlopen_callback()`。
 
 你可以参考 [bytehook-sample](bytehook_sample) 文件夹中的示例 app。
 
 
+## 文档
+
+[Documentation](doc)
+
+
 ## 贡献
 
 [Contributing Guide](CONTRIBUTING.md)

doc/README.md

@@ -0,0 +1,15 @@
+# ByteHook Documentation
+
+Only Chinese documents are now available.
+
+现在只有中文文档。
+
+[项目介绍和原理概述](overview.zh-CN.md)
+
+[快速入门使用](quickstart.zh-CN.md)
+
+[Java API 手册](java_manual.zh-CN.md)
+
+[Native API 手册](native_manual.zh-CN.md)
+
+[状态码](status_code.zh-CN.md)