From dd7912a5776e7775dedcaa7a2584048abbaac8c3 Mon Sep 17 00:00:00 2001 From: fankesyooni Date: Thu, 21 Sep 2023 03:16:23 +0800 Subject: [PATCH] docs: update README, README-zh-CN --- README-zh-CN.md | 65 ++++++++++++++++++++++++++++--------------------- README.md | 64 ++++++++++++++++++++++++++++-------------------- 2 files changed, 74 insertions(+), 55 deletions(-) diff --git a/README-zh-CN.md b/README-zh-CN.md index f3472197..7430f5f8 100644 --- a/README-zh-CN.md +++ b/README-zh-CN.md @@ -1,47 +1,47 @@ # Yuki Hook API -![Blank](https://img.shields.io/badge/license-MIT-blue) -![Blank](https://img.shields.io/badge/version-v1.1.11-green) -[![Telegram](https://img.shields.io/badge/Follow-Telegram-blue.svg?logo=telegram)](https://t.me/YukiHookAPI) -

- -
-
+[![GitHub license](https://img.shields.io/github/license/fankes/YukiHookAPI?color=blue)](https://github.com/fankes/YukiHookAPI/blob/master/LICENSE) +[![GitHub release](https://img.shields.io/github/v/release/fankes/YukiHookAPI?display_name=release&logo=github&color=green)](https://github.com/fankes/YukiHookAPI/releases) +[![Telegram](https://img.shields.io/badge/discussion-Telegram-blue.svg?logo=telegram)](https://t.me/YukiHookAPI) +[![Telegram](https://img.shields.io/badge/discussion%20dev-Telegram-blue.svg?logo=telegram)](https://t.me/HighCapable_Dev) + +LOGO + ⛱️ 一个使用 Kotlin 构建的高效 Hook API 与 Xposed 模块解决方案。 -
[English](https://github.com/fankes/YukiHookAPI/blob/master/README.md) | 简体中文 ## 这是什么 -- 这是一个使用 Kotlin 基于 Xposed API 重新构建的高效 Hook API，同时为 Xposed 模块的开发打造了丰富的功能扩展 -- 名称取自 [《ももくり》女主 栗原 雪(Yuki)](https://www.bilibili.com/bangumi/play/ss5016) -- 前身为 [开发学习项目](https://github.com/fankes/TMore) 中使用的 Innocent Xposed API，现在重新命名并开源 +这是一个使用 Kotlin 基于 Xposed API 重新构建的高效 Hook API，同时为 Xposed 模块的开发打造了丰富的功能扩展。 + +名称取自 [《ももくり》女主 栗原 雪(Yuki)](https://www.bilibili.com/bangumi/play/ss5016)。 + +前身为 [开发学习项目](https://github.com/fankes/TMore) 中使用的 Innocent Xposed API，现在重新命名并开源。 ## 支持的功能 -- Hook Framework 支持的基本 ART 动态方法 Hook 功能 -- Xposed 资源钩子 (Resources Hook) +> 基本功能 + +- [x] Hook Framework 支持的基本 ART 动态方法 Hook 功能 +- [x] Xposed 资源钩子 (Resources Hook) **(计划 2.x.x 版本作废)** + +> Hook Frameworks API + +- [x] [Rovo89 Xposed API](https://api.xposed.info) +- [ ] [Modern Xposed API](https://github.com/libxposed) **(计划 2.x.x 版本支持)** ## 扩展功能 -- 自动化 Xposed 模块构建 (完全无需自行创建 `assets/xposed_init`) -- [New XSharedPreferences](https://github.com/LSPosed/LSPosed/wiki/New-XSharedPreferences#for-the-module) 支持 -- DataChannel (宿主 ←→ 模块) 无序广播通讯通道功能 -- 简单快捷地实现混淆的字节码反射、查找功能 +- [x] 自动化 Xposed 模块构建 (完全无需自行创建 `assets/xposed_init`) +- [x] [New XSharedPreferences](https://github.com/LSPosed/LSPosed/wiki/New-XSharedPreferences#for-the-module) +- [x] DataChannel (宿主 ←→ 模块) +- [x] 混淆的字节码查找 & 反射 (由 [YukiReflection](https://github.com/fankes/YukiReflection) 提供支持) ## 开始使用 - [点击这里](https://fankes.github.io/YukiHookAPI/zh-cn/) 前往文档页面查看更多详细教程和内容。 -## 联系我们 - -- [点击加入 Telegram 群组](https://t.me/YukiHookAPI) - -## 展望未来 - -如果你喜欢 `YukiHookAPI` 项目，欢迎为此项目贡献你的代码 **PR**，可以是任何改进的建议以及新增的功能。 - ## 合作项目 以下是经过合作并稳定使用 `YukiHookAPI` 的项目。 @@ -68,12 +68,21 @@ | [Fuck AD](https://github.com/hujiayucc/Fuck-AD) | [hujiayucc](https://github.com/hujiayucc) | | [最右强力去广告](https://github.com/kazutoiris/zuiyou-adfree) | [kazutoiris](https://github.com/kazutoiris) | -你也在使用 `YukiHookAPI` 吗？快来 **PR** 将你的存储仓库添加到上方的列表(私有仓库可以不需要注明网页链接)。 +你也在使用 `YukiHookAPI` 吗？快来 **PR** 将你的存储仓库添加到上方的列表 (私有仓库可以不需要注明网页链接)。 + +## 项目推广 + +如果你正在寻找一个可以自动管理 Gradle 项目依赖的 Gradle 插件，你可以了解一下 [SweetDependency](https://github.com/HighCapable/SweetDependency) 项目。 + +如果你正在寻找一个可以自动生成属性键值的 Gradle 插件，你可以了解一下 [SweetProperty](https://github.com/HighCapable/SweetProperty) 项目。 + +本项目同样使用了 **SweetDependency** 和 **SweetProperty**。 ## 捐赠支持 -- 工作不易，无意外情况此项目将继续维护下去，提供更多可能，欢迎打赏。

- +工作不易，无意外情况此项目将继续维护下去，提供更多可能，欢迎打赏。 + +Payment Code ## Star History diff --git a/README.md b/README.md index a0f62ed5..8b54a5a7 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,47 @@ # Yuki Hook API -![Blank](https://img.shields.io/badge/license-MIT-blue) -![Blank](https://img.shields.io/badge/version-v1.1.11-green) -[![Telegram](https://img.shields.io/badge/Follow-Telegram-blue.svg?logo=telegram)](https://t.me/YukiHookAPI) -

- -
-
+[![GitHub license](https://img.shields.io/github/license/fankes/YukiHookAPI?color=blue)](https://github.com/fankes/YukiHookAPI/blob/master/LICENSE) +[![GitHub release](https://img.shields.io/github/v/release/fankes/YukiHookAPI?display_name=release&logo=github&color=green)](https://github.com/fankes/YukiHookAPI/releases) +[![Telegram](https://img.shields.io/badge/discussion-Telegram-blue.svg?logo=telegram)](https://t.me/YukiHookAPI) +[![Telegram](https://img.shields.io/badge/discussion%20dev-Telegram-blue.svg?logo=telegram)](https://t.me/HighCapable_Dev) + +LOGO + ⛱️ An efficient Hook API and Xposed Module solution built in Kotlin. -
English | [简体中文](https://github.com/fankes/YukiHookAPI/blob/master/README-zh-CN.md) ## What's this -- This is an efficient Hook API rebuilt based on the Xposed API using Kotlin, and creates rich function extensions for the development of - Xposed Modules -- The name is taken from ["ももくり" heroine Yuki Kurihara](https://www.bilibili.com/bangumi/play/ss5016) -- Formerly the Innocent Xposed API used in [Development Learning Project](https://github.com/fankes/TMore), now renamed and open sourced +This is an efficient Hook API rebuilt based on the Xposed API using Kotlin, +and creates rich function extensions for the development of Xposed Modules. + +The name is taken from ["ももくり" heroine Yuki Kurihara](https://www.bilibili.com/bangumi/play/ss5016). + +Formerly the Innocent Xposed API used in [Development Learning Project](https://github.com/fankes/TMore), now renamed and open sourced. ## Supports -- Basic ART dynamic method hook functions supported by Hook Framework -- Xposed Resources Hook +> Basic Functions + +- [x] Basic ART dynamic method hook functions supported by Hook Framework +- [x] Xposed Resources Hook **(Will be deprecated on 2.x.x)** + +> Hook Frameworks API + +- [x] [Rovo89 Xposed API](https://api.xposed.info) +- [ ] [Modern Xposed API](https://github.com/libxposed) **(Will be supported on 2.x.x)** ## Extensions -- Automatic Xposed Module Build (No need to create `assets/xposed_init` by yourself) -- [New XSharedPreferences](https://github.com/LSPosed/LSPosed/wiki/New-XSharedPreferences#for-the-module) Supports -- DataChannel (Host ←→ Module) -- Simple and quick implementation of obfuscated bytecode reflection and finding functions +- [x] Automatic Xposed Module Build (No need to create `assets/xposed_init` by yourself) +- [x] [New XSharedPreferences](https://github.com/LSPosed/LSPosed/wiki/New-XSharedPreferences#for-the-module) +- [x] DataChannel (Host ←→ Module) +- [x] Obfuscated Bytecode Finding & Reflection by [YukiReflection](https://github.com/fankes/YukiReflection) ## Get Started -- [Click here](https://fankes.github.io/YukiHookAPI/en/) go to the documentation page for more detailed tutorials and content. - -## Contacts - -- [Follow us on Telegram](https://t.me/YukiHookAPI) - -## Features - -If you like the `YukiHookAPI` project, we welcome you to make a **PR** in this project, any suggestions for improvement and new features. +[Click here](https://fankes.github.io/YukiHookAPI/en/) go to the documentation page for more detailed tutorials and content. ## Cooperations @@ -72,6 +72,16 @@ The following are projects that have collaborated and are using `YukiHookAPI`. Are you also using `YukiHookAPI`? Come and **PR** to add your repository to the list above (private repositories do not need to indicate web links). +## Promotion + +If you are looking for a Gradle plugin that can automatically manage Gradle project dependencies, +you can check out the [SweetDependency](https://github.com/HighCapable/SweetDependency) project. + +If you are looking for a Gradle plugin that can automatically generate properties key-values, +you can check out the [SweetProperty](https://github.com/HighCapable/SweetProperty) project. + +This project also uses **SweetDependency** and **SweetProperty**. + ## Star History ![Star History Chart](https://api.star-history.com/svg?repos=fankes/YukiHookAPI&type=Date)