update readme

This commit is contained in:
j-hc 2023-09-24 15:36:16 +03:00
parent 26ae60b118
commit 1be7e530ce
No known key found for this signature in database
GPG Key ID: B69B8F690911EFCC

View File

@ -10,21 +10,25 @@ Get the [latest CI release](https://github.com/j-hc/revanced-magisk-module/relea
Use [**zygisk-detach**](https://github.com/j-hc/zygisk-detach) to detach YouTube and YT Music from Play Store if you are using magisk modules.
## Features
* Support all present and future ReVanced and [ReVanced Extended](https://github.com/inotia00/revanced-patches) apps
* Can build Magisk modules and non-root APKs
* Updated daily with the latest versions of apps and patches
* Optimize APKs and modules for size
* Modules
* recompile invalidated odex for faster usage
* receive updates from Magisk app
* do not break safetynet or trigger root detections
* handle installation of the correct version of the stock app and all that
* support Magisk and KernelSU
<details><summary><big>Features</big></summary>
<ul>
<li>Support all present and future ReVanced and <a href="https://github.com/inotia00/revanced-patches">ReVanced Extended</a> apps</li>
<li> Can build Magisk modules and non-root APKs</li>
<li> Updated daily with the latest versions of apps and patches</li>
<li> Optimize APKs and modules for size</li>
<li> Modules</li>
<ul>
<li> recompile invalidated odex for faster usage</li>
<li> receive updates from Magisk app</li>
<li> do not break safetynet or trigger root detections</li>
<li> handle installation of the correct version of the stock app and all that</li>
<li> support Magisk and KernelSU</li>
</ul>
</ul>
Note that the <a href="../../actions/workflows/ci.yml">CI workflow</a> is scheduled to build the modules and APKs everyday using GitHub Actions if there is a change in ReVanced patches. You may want to disable it.
</details>
#### **Note that the [CI workflow](../../actions/workflows/ci.yml) is scheduled to build the modules and APKs everyday using GitHub Actions if there is a change in ReVanced patches. You may want to disable it.**
## To include/exclude patches or patch more ReVanced Apps
## To include/exclude patches or patch other apps
[**See the list of patches**](https://j-hc.github.io/rvmm-config-gen/)
* Star the repo :eyes:
@ -35,13 +39,13 @@ Use [**zygisk-detach**](https://github.com/j-hc/zygisk-detach) to detach YouTube
also see here [`CONFIG.md`](./CONFIG.md)
# Building Locally
## On Termux
## Building Locally
### On Termux
```console
bash <(curl -sSf https://raw.githubusercontent.com/j-hc/revanced-magisk-module/main/build-termux.sh)
```
## On Desktop
### On Desktop
```console
$ git clone https://github.com/j-hc/revanced-magisk-module
$ cd revanced-magisk-module