README.md

                       

Continuing the legacy of Vanced

📚 ReVanced Library

Library containing common utilities for ReVanced.

❓ About

ReVanced Library powers projects such as ReVanced Manager, 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 via ADB or locally, the Android package manager, or by mounting using root permissions
• 📦 Repackage patched files to an APK: Apply patched files from 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 to your project

2. Add the dependency to your project:

    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.

🛠️ Building

To build ReVanced Library, you can follow the ReVanced documentation.

📜 Licence

ReVanced Library is licensed under the GPLv3 license. Please see the licence file for more information. tl;dr 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.