diff --git a/README.md b/README.md new file mode 100644 index 0000000..ac0d03a --- /dev/null +++ b/README.md @@ -0,0 +1,117 @@ +

+ + + + +
+ + + + + +     + + + + + +     + + + + + +     + + + + + +     + + + + + +     + + + + + +     + + + + + + +
+
+ Continuing the legacy of Vanced +

+ +# 📚 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.