From ef5e93d96cf7f646e67a4f16a86260142b68330b Mon Sep 17 00:00:00 2001 From: Nullptr <52071314+Dr-TSNG@users.noreply.github.com> Date: Fri, 6 May 2022 16:20:54 +0800 Subject: [PATCH] Update README.md --- README.md | 62 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 34 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 52014c2..9273f2a 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,42 @@ +# LSPatch Framework + +![Build](https://shields.io/github/workflow/status/LSPosed/LSPatch/Android%20CI?event=push&logo=github&label=Build) [![Crowdin](https://img.shields.io/badge/Localization-Crowdin-blueviolet?logo=Crowdin)](https://lsposed.crowdin.com/lspatch) [![Download](https://img.shields.io/github/v/release/LSPosed/LSPatch?color=orange&logoColor=orange&label=Download&logo=DocuSign)](https://github.com/LSPosed/LSPatch/releases/latest) [![Total](https://shields.io/github/downloads/LSPosed/LSPatch/total?logo=Bookmeter&label=Counts&logoColor=yellow&color=yellow)](https://github.com/LSPosed/LSPatch/releases) + ## Introduction -LSPatch fork from Xpatch. +Rootless implementation of LSPosed framework, integrating Xposed API by inserting dex and so into the target APK. -LSPatch provides a way to insert dex and so into the target APK by repackaging. The following changes have been made since Xpatch - -1. use LSPosed as Hook framework -1. Clean up the code -1. merge Xpatch's Loader and Patch into a single project - - -## Usage - -1. download the artifact -1. run `java -jar lspatch.jar` - -## Dev - -``` -Android Studio Arctic Fox | 2020.3.1 + -``` - -## Build - -``` -gradlew build -``` - -## Supported Android Versions +## Supported Versions - Min: Android 9 - Max: In theory, same with [LSPosed](https://github.com/LSPosed/LSPosed#supported-versions) -## Known issues +## Download -1. Can't solve the signature verification issue perfectly \ No newline at end of file +For stable releases, please go to [Github Releases page](https://github.com/LSPosed/LSPatch/releases) +For canary build, please check [Github Actions](https://github.com/LSPosed/LSPatch/actions) +Note: debug builds are only available in Github Actions + +## Usage + ++ Through jar +1. Download `lspatch.jar` +1. Run `java -jar lspatch.jar` + ++ Through manager +1. Download and install `manager.apk` on an Android device +1. Follow the instructions of the manager app + +## Translation Contributing + +You can contribute translation [here](https://lsposed.crowdin.com/lspatch). + +## Credits + +- [LSPosed](https://github.com/LSPosed/LSPosed): core framework +- [Xpatch](https://github.com/WindySha/Xpatch): fork source +- [Apkzlib](https://android.googlesource.com/platform/tools/apkzlib): Repacking tool + +## License + +LSPatch is licensed under the **GNU General Public License v3 (GPL-3)** (http://www.gnu.org/copyleft/gpl.html).