From d02a5f82824ef4fc8512ea1877b0ad0b310aefb9 Mon Sep 17 00:00:00 2001 From: fankesyooni Date: Fri, 22 Sep 2023 17:00:22 +0800 Subject: [PATCH] docs: update README, README-zh-CN --- README-zh-CN.md | 52 +++++++++++++++++++-------------------------- README.md | 56 +++++++++++++++++++++---------------------------- 2 files changed, 46 insertions(+), 62 deletions(-) diff --git a/README-zh-CN.md b/README-zh-CN.md index d0b176c..419c4b2 100644 --- a/README-zh-CN.md +++ b/README-zh-CN.md @@ -1,53 +1,45 @@ # Yuki Reflection -![Blank](https://img.shields.io/badge/license-MIT-blue) -![Blank](https://img.shields.io/badge/version-v1.0.2-green) -[![Telegram](https://img.shields.io/badge/Follow-Telegram-blue.svg?logo=telegram)](https://t.me/YukiReflection) -

- -
-
-🌴️ 一个使用 Kotlin 构建的 Android 平台高效反射 API。 -
+[![GitHub license](https://img.shields.io/github/license/fankes/YukiReflection?color=blue)](https://github.com/fankes/YukiReflection/blob/master/LICENSE) +[![GitHub release](https://img.shields.io/github/v/release/fankes/YukiReflection?display_name=release&logo=github&color=green)](https://github.com/fankes/YukiReflection/releases) +[![Telegram](https://img.shields.io/badge/discussion-Telegram-blue.svg?logo=telegram)](https://t.me/YukiReflection) +[![Telegram](https://img.shields.io/badge/discussion%20dev-Telegram-blue.svg?logo=telegram)](https://t.me/HighCapable_Dev) + +LOGO + +🌴️ 一个使用 Kotlin 构建的用于 Java 和 Android 平台高效反射 API。 [English](https://github.com/fankes/YukiReflection/blob/master/README.md) | 简体中文 ## 这是什么 -- 这是一个使用 Kotlin 基于 Java 原生反射 API 重新打造的一套简洁、高效的反射 API，同时也是 [YukiHookAPI](https://github.com/fankes/YukiHookAPI) 正在使用的核心功能 -- 名称取自 [《ももくり》女主 栗原 雪(Yuki)](https://www.bilibili.com/bangumi/play/ss5016) +这是一个使用 Kotlin 基于 Java 原生反射 API 重新打造的一套简洁、高效的反射 API，同时也是 [YukiHookAPI](https://github.com/fankes/YukiHookAPI) 正在使用的核心功能。 + +名称取自 [《ももくり》女主 栗原 雪(Yuki)](https://www.bilibili.com/bangumi/play/ss5016)。 ## 它能做什么 -- 取代 Java 原生的反射 API，使用更加人性化的语言实现一套更加完善的反射方案 -- 使用注解的方式声明需要反射的类或方法、变量，构造一个 `stub`，直接调用即可实现与反射 API 相同的功能，更加优雅高效 (正在开发，预计在后期逐渐实现此功能) +取代 Java 原生的反射 API，使用更加人性化的语言实现一套更加完善的反射方案。 + +使用注解的方式声明需要反射的类或方法、变量，构造一个 `stub`，直接调用即可实现与反射 API 相同的功能，更加优雅高效。 (正在开发，预计在后期逐渐实现此功能) ## 开始使用 -- [点击这里](https://fankes.github.io/YukiReflection/zh-cn/) 前往文档页面查看更多详细教程和内容。 +[点击这里](https://fankes.github.io/YukiReflection/zh-cn/) 前往文档页面查看更多详细教程和内容。 -## 联系我们 +## 项目推广 -- [点击加入 Telegram 群组](https://t.me/YukiReflection) +如果你正在寻找一个可以自动管理 Gradle 项目依赖的 Gradle 插件，你可以了解一下 [SweetDependency](https://github.com/HighCapable/SweetDependency) 项目。 -## 展望未来 +如果你正在寻找一个可以自动生成属性键值的 Gradle 插件，你可以了解一下 [SweetProperty](https://github.com/HighCapable/SweetProperty) 项目。 -如果你喜欢 `YukiReflection` 项目，欢迎为此项目贡献你的代码 **PR**，可以是任何改进的建议以及新增的功能。 - -## 合作项目 - -以下是经过合作并稳定使用 `YukiReflection` 的项目。 - -| Repository | Developer | -|------------------------------------------------------|------------------------------------------| -| [YukiHookAPI](https://github.com/fankes/YukiHookAPI) | [fankesyooni](https://github.com/fankes) | - -你也在使用 `YukiReflection` 吗？快来 **PR** 将你的存储仓库添加到上方的列表 (私有仓库可以不需要注明网页链接)。 +本项目同样使用了 **SweetDependency** 和 **SweetProperty**。 ## 捐赠支持 -- 工作不易，无意外情况此项目将继续维护下去，提供更多可能，欢迎打赏。

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

- -
-
-🌴️ An efficient Reflection API for the Android platform built in Kotlin. -
+[![GitHub license](https://img.shields.io/github/license/fankes/YukiReflection?color=blue)](https://github.com/fankes/YukiReflection/blob/master/LICENSE) +[![GitHub release](https://img.shields.io/github/v/release/fankes/YukiReflection?display_name=release&logo=github&color=green)](https://github.com/fankes/YukiReflection/releases) +[![Telegram](https://img.shields.io/badge/discussion-Telegram-blue.svg?logo=telegram)](https://t.me/YukiReflection) +[![Telegram](https://img.shields.io/badge/discussion%20dev-Telegram-blue.svg?logo=telegram)](https://t.me/HighCapable_Dev) + +LOGO + +🌴️ An efficient Reflection API for Java and Android built in Kotlin. English | [简体中文](https://github.com/fankes/YukiReflection/blob/master/README-zh-CN.md) ## What's this -- This is a concise and efficient Reflection API rebuilt based on Java's native Reflection API using Kotlin, and it is also the core function - being used by [YukiHookAPI](https://github.com/fankes/YukiHookAPI) -- The name is taken from ["ももくり" heroine Yuki Kurihara](https://www.bilibili.com/bangumi/play/ss5016) +This is a concise and efficient Reflection API rebuilt based on Java's native Reflection API using Kotlin, +and it is also the core function being used by [YukiHookAPI](https://github.com/fankes/YukiHookAPI). + +The name is taken from ["ももくり" heroine Yuki Kurihara](https://www.bilibili.com/bangumi/play/ss5016). ## What it can do -- Instead of Java's native Reflection API, use a more user-friendly language to implement a more complete set of reflection solutions -- Use annotations to declare classes, methods, and fields that need reflection, construct a `stub`, and call directly to achieve the same - function as the Reflection API, which is more elegant and efficient (under development, and it is expected to gradually implement this function - later) +Instead of Java's native Reflection API, use a more user-friendly language to implement a more complete set of reflection solutions. + +Use annotations to declare classes, methods, and fields that need reflection, construct a `stub`, +and call directly to achieve the same function as the Reflection API, which is more elegant and efficient. +(under development, and it is expected to gradually implement this function later) ## Get Started -- [Click here](https://fankes.github.io/YukiReflection/en/) go to the documentation page for more detailed tutorials and content. +[Click here](https://fankes.github.io/YukiReflection/en/) go to the documentation page for more detailed tutorials and content. -## Contacts +## Promotion -- [Follow us on Telegram](https://t.me/YukiReflection) +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. -## Features +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. -If you like the `YukiReflection` project, we welcome you to make a **PR** in this project, any suggestions for improvement and new features. - -## Cooperations - -The following are projects that have collaborated and are using `YukiReflection`. - -| Repository | Developer | -|------------------------------------------------------|------------------------------------------| -| [YukiHookAPI](https://github.com/fankes/YukiHookAPI) | [fankesyooni](https://github.com/fankes) | - -Are you also using `YukiReflection`? Come and **PR** to add your repository to the list above (private repositories do not need to indicate web -links). +This project also uses **SweetDependency** and **SweetProperty**. ## Star History