Skip to content

Commit 0b0d740

Browse files
committed
Update project references and polish content of docs (#639)
- Migrate repository links from LSPosed to Vector. - Add detailed guidelines for CI builds and `libxposed` submodule integration. - Minor wording updates: `Telemetry` sounds potentially negative.
1 parent 714e6c8 commit 0b0d740

2 files changed

Lines changed: 28 additions & 14 deletions

File tree

README.md

Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44

55
**A high-performance ART hooking framework for modern Android**
66

7-
[![Build](https://img.shields.io/github/actions/workflow/status/JingMatrix/LSPosed/core.yml?branch=master&event=push&logo=github&label=Build)](https://github.com/JingMatrix/LSPosed/actions/workflows/core.yml?query=event%3Apush+branch%3Amaster+is%3Acompleted)
7+
[![Build](https://img.shields.io/github/actions/workflow/status/JingMatrix/Vector/core.yml?branch=master&event=push&logo=github&label=Build)](https://github.com/JingMatrix/Vector/actions/workflows/core.yml?query=event%3Apush+branch%3Amaster+is%3Acompleted)
88
[![Crowdin](https://img.shields.io/badge/Localization-Crowdin-blueviolet?logo=Crowdin)](https://crowdin.com/project/lsposed_jingmatrix)
9-
[![Download](https://img.shields.io/github/v/release/JingMatrix/LSPosed?color=orange&logoColor=orange&label=Download&logo=DocuSign)](https://github.com/JingMatrix/LSPosed/releases/latest)
10-
[![Total](https://shields.io/github/downloads/JingMatrix/LSPosed/total?logo=Bookmeter&label=Counts&logoColor=yellow&color=yellow)](https://github.com/JingMatrix/LSPosed/releases)
9+
[![Download](https://img.shields.io/github/v/release/JingMatrix/Vector?color=orange&logoColor=orange&label=Download&logo=DocuSign)](https://github.com/JingMatrix/Vector/releases/latest)
10+
[![Total](https://shields.io/github/downloads/JingMatrix/Vector/total?logo=Bookmeter&label=Counts&logoColor=yellow&color=yellow)](https://github.com/JingMatrix/Vector/releases)
1111

1212
</div>
1313

@@ -23,7 +23,7 @@ The framework allows modules to modify system and application behavior in-memory
2323

2424
### Compatibility
2525

26-
Vector supports devices running **Android 8.1 through Android 17 Beta**.
26+
Vector supports devices running **Android 8.1 through Android 17 Beta**.
2727

2828
> [!TIP]
2929
> This framework requires a recent installation of Magisk or KernelSU with Zygisk enabled.
@@ -44,27 +44,35 @@ Vector supports devices running **Android 8.1 through Android 17 Beta**.
4444

4545
| Channel | Source |
4646
| :--- | :--- |
47-
| Stable Releases | [GitHub Releases](https://github.com/JingMatrix/LSPosed/releases) |
48-
| Canary Builds | [GitHub Actions](https://github.com/JingMatrix/LSPosed/actions/workflows/core.yml?query=branch%3Amaster) |
47+
| **Stable Releases** | [GitHub Releases](https://github.com/JingMatrix/Vector/releases) |
48+
| **Canary (CI) Builds** | [GitHub Actions](https://github.com/JingMatrix/Vector/actions/workflows/core.yml?query=branch%3Amaster) |
4949

5050
> [!NOTE]
51-
> Debug builds are recommended for users experiencing technical difficulties.
51+
> Debug builds are recommended for users encountering issues or performing troubleshooting.
52+
> We encourage users to test CI builds to help us identify bugs and accelerate development.
53+
54+
> [!CAUTION]
55+
> GitHub requires users to be **logged in** to download CI artifacts.
56+
>
57+
> The link above is filtered to show only `master` branch builds.
58+
> Please note that builds from Pull Requests (PRs) are often unstable and potentially unsafe (depending on the authors); we recommend staying on the `master` branch for verified builds, unless you are asked to help our debugging sessions.
5259
5360
---
5461

5562
### Support and Contribution
5663

5764
If you encounter issues or wish to help improve the project, please refer to the resources below.
5865

59-
* **Troubleshooting:** Consult the [guide](https://github.com/JingMatrix/LSPosed/issues/123) before reporting bugs.
60-
* **Discussions:** Join our community on [GitHub Discussions](https://github.com/JingMatrix/LSPosed/discussions).
66+
* **Troubleshooting:** Consult the [guide](https://github.com/JingMatrix/Vector/issues/123) before reporting bugs.
67+
* **Discussions:** Join our community on [GitHub Discussions](https://github.com/JingMatrix/Vector/discussions).
6168
* **Localization:** Help translate the project via [Crowdin](https://crowdin.com/project/lsposed_jingmatrix).
6269

6370
> [!IMPORTANT]
64-
> Bug reports are only accepted if they are based on the **latest debug build**.
65-
>
66-
> For Chinese speakers: 本项目只接受英语标题的 Issue。
67-
> 请使用[翻译工具](https://www.deepl.com/zh/translator)提交。
71+
> Bug reports are only accepted if they are based on the **latest debug build**.
72+
>
73+
> *Notice for Chinese speakers:*
74+
>
75+
> 为了提高沟通效率,本项目仅接受英文 Issue。请使用 [DeepL](https://www.deepl.com/zh/translator) 或其他翻译工具提交您的反馈。
6876
6977
---
7078

@@ -76,6 +84,12 @@ Vector supports both legacy and modern hooking standards to ensure broad module
7684
* [Modern libxposed API](https://libxposed.github.io/api/)
7785
* [Xposed Module Repository](https://github.com/Xposed-Modules-Repo)
7886

87+
> [!NOTE]
88+
> Vector supports the `libxposed` API via two git submodules: the [module API](./xposed/) and the [service API](./services/).
89+
>
90+
> A successful GitHub Actions build of the [master](https://github.com/JingMatrix/Vector/tree/master) branch indicates that Vector fully supports these APIs at those specific commits.
91+
> Developers are suggested to check out the same commits as Vector.
92+
7993
---
8094

8195
### Credits

daemon/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ When the wrapper executes, it connects to the daemon's abstract UNIX domain sock
7979

8080
If the wrapper is disabled or incompatible, the daemon unmounts the binaries and utilizes `resetprop` to inject the inline flag directly into the `dalvik.vm.dex2oat-flags` system property as a fallback. The Kotlin daemon continuously monitors SELinux states via a `FileObserver` on `/sys/fs/selinux/enforce` and its policy files. It dynamically remounts the wrappers if the system drops to permissive mode or alters policy, ensuring the interception persists across state changes.
8181

82-
### Native Logcat Telemetry
82+
### Native Logcat Monitoring
8383
Instead of relying on standard logcat shell execution, the daemon runs a native C++ process that interfaces directly with Android's `liblog` buffers (`LOG_ID_MAIN` and `LOG_ID_CRASH`).
8484

8585
The native parser performs zero-copy processing of log events, strictly filtering output by predefined exact tags (e.g., Magisk, KernelSU) and prefix tags (e.g., dex2oat, Vector, LSPosed). It writes the filtered output into two rotating log files: one for module frameworks and one for verbose system debugging, rotating them automatically when they reach 4MB.

0 commit comments

Comments
 (0)