-
-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
117 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,117 @@ | ||
<p align="center"> | ||
<picture> | ||
<source | ||
width="256px" | ||
media="(prefers-color-scheme: dark)" | ||
srcset="assets/revanced-headline/revanced-headline-vertical-dark.svg" | ||
> | ||
<img | ||
width="256px" | ||
src="assets/revanced-headline/revanced-headline-vertical-light.svg" | ||
> | ||
</picture> | ||
<br> | ||
<a href="https://revanced.app/"> | ||
<picture> | ||
<source height="24px" media="(prefers-color-scheme: dark)" srcset="assets/revanced-logo/revanced-logo.svg" /> | ||
<img height="24px" src="assets/revanced-logo/revanced-logo.svg" /> | ||
</picture> | ||
</a> | ||
<a href="https://github.com/ReVanced"> | ||
<picture> | ||
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://i.ibb.co/dMMmCrW/Git-Hub-Mark.png" /> | ||
<img height="24px" src="https://i.ibb.co/9wV3HGF/Git-Hub-Mark-Light.png" /> | ||
</picture> | ||
</a> | ||
<a href="http://revanced.app/discord"> | ||
<picture> | ||
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" /> | ||
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" /> | ||
</picture> | ||
</a> | ||
<a href="https://reddit.com/r/revancedapp"> | ||
<picture> | ||
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" /> | ||
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" /> | ||
</picture> | ||
</a> | ||
<a href="https://t.me/app_revanced"> | ||
<picture> | ||
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" /> | ||
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" /> | ||
</picture> | ||
</a> | ||
<a href="https://x.com/revancedapp"> | ||
<picture> | ||
<source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/93124920/270180600-7c1b38bf-889b-4d68-bd5e-b9d86f91421a.png"> | ||
<img height="24px" src="https://user-images.githubusercontent.com/93124920/270108715-d80743fa-b330-4809-b1e6-79fbdc60d09c.png" /> | ||
</picture> | ||
</a> | ||
<a href="https://www.youtube.com/@ReVanced"> | ||
<picture> | ||
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" /> | ||
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" /> | ||
</picture> | ||
</a> | ||
<br> | ||
<br> | ||
Continuing the legacy of Vanced | ||
</p> | ||
|
||
# 📚 ReVanced Library | ||
|
||
![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/ReVanced/revanced-library/release.yml) | ||
![GPLv3 License](https://img.shields.io/badge/License-GPL%20v3-yellow.svg) | ||
|
||
Library containing common utilities for ReVanced. | ||
|
||
## ❓ About | ||
|
||
ReVanced Library powers projects such as [ReVanced Manager](https://github.com/ReVanced/revanced-manager), | ||
[ReVanced CLI](https://github.com/ReVanced/revanced-cli) with common utilities and functionalities | ||
by providing shared code. | ||
|
||
## 💪 Features | ||
|
||
Some of the features the ReVanced Library provides are: | ||
|
||
- 📝 **Signing APKs**: Read and write keystores, and sign APK files | ||
- 🧩 **Common utility functions**: Various APIs for ReVanced patches such as JSON serialization, | ||
reading and setting patch options, calculating the most common compatible version for a set of patches and more | ||
- 💾 **Install and uninstall APKs**: Install and uninstall APK files using ADB locally, | ||
using the Android package manager, or by mounting using root permissions | ||
- 📦 **Repackage patched files to an APK**: Apply patched files from | ||
[ReVanced Patcher](https://github.com/revanced/revanced-patcher) to an APK file, and align & sign the APK file automatically | ||
|
||
## 🚀 How to get started | ||
|
||
To use ReVanced Library in your project, follow these steps: | ||
|
||
1. [Add the repository](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry#using-a-published-package) | ||
to your project | ||
2. Add the dependency to your project: | ||
|
||
```kt | ||
dependencies { | ||
implementation("app.revanced:revanced-library:{$version}") | ||
} | ||
``` | ||
|
||
## 📚 Everything else | ||
|
||
### 📙 Contributing | ||
|
||
Thank you for considering contributing to ReVanced Library. | ||
You can find the contribution guidelines [here](CONTRIBUTING.md). | ||
|
||
### 🛠️ Building | ||
|
||
To build ReVanced Library, | ||
you can follow the [ReVanced documentation](https://github.com/ReVanced/revanced-documentation). | ||
|
||
## 📜 Licence | ||
|
||
ReVanced Library is licensed under the GPLv3 license. Please see the [licence file](LICENSE) for more information. | ||
[tl;dr](https://www.tldrlegal.com/license/gnu-general-public-license-v3-gpl-3) you may copy, distribute and modify ReVanced Library as long as you track changes/dates in source files. | ||
Any modifications to ReVanced Library must also be made available under the GPL, | ||
along with build & install instructions. |