diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 131ffa7700..50095377f6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -45,7 +45,7 @@ This document describes how to contribute to ReVanced Patches. ## 📖 Resources to help you get started -* [The documentation](https://github.com/ReVanced/revanced-patches/tree/docs/docs) provides the fundamentals of patches +* The [documentation](https://github.com/ReVanced/revanced-patches/tree/docs/docs) provides the fundamentals of patches and everything necessary to create your own patch from scratch * [Our backlog](https://github.com/orgs/ReVanced/projects/12) is where we keep track of what we're working on * [Issues](https://github.com/ReVanced/revanced-patches/issues) are where we keep track of bugs and feature requests diff --git a/README.md b/README.md index b76165a9be..6d0a08fd69 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,91 @@ +

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

+ + # 🧩 ReVanced Patches -Patches for ReVanced. +![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/ReVanced/revanced-patches/release.yml) +![GPLv3 License](https://img.shields.io/badge/License-GPL%20v3-yellow.svg) + +This repository contains a collection of ReVanced Patches. + +## ❓ About + +Patches are small modifications to Android apps that allow you to change the behaviour of or add new features, +block ads, customize the appearance, and much more. + +## 💪 Features + +Some of the features the patches provide are: + +* 🚫 **Block ads**: Say goodbye to ads +* ⭐ **Customize your app**: Personalize the appearance of apps with various layouts and themes +* 🪄 **Add new features**: Extend the functionality of apps with lots of new features +* ⚙️ **Miscellaneous and general purpose**: Rename packages, enable debugging, disable screen capture restrictions, +export activities, etc. +* ✨ **And much more!** + +For a full list of all available patches, visit [revanced.app/patches](https://revanced.app/patches). + +## 🚀 How to get started + +You can use [ReVanced CLI](https://github.com/ReVanced/revanced-cli) or [ReVanced Manager](https://github.com/ReVanced/revanced-manager) to use ReVanced Patches. + +## 📚 Everything else + +### 📙 Contributing + +Thank you for considering contributing to ReVanced Patches. You can find the contribution guidelines [here](CONTRIBUTING.md). + +### 📃 Documentation + +The documentation provides the fundamentals of patches and everything necessary to create your own patch from scratch. +You can find it [here](https://github.com/ReVanced/revanced-patches/tree/docs/docs). + +### 🛠️ Building + +In order to build ReVanced Patches, you can follow the [ReVanced documentation](https://github.com/ReVanced/revanced-documentation). + +## 📜 Licence + +ReVanced Patches is licensed under the GPLv3 licence. 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 patches as long as you track changes/dates in source files. +Any modifications to ReVanced Patches must also be made available under the GPL along with build & install instructions.