diff --git a/README.md b/README.md index 0b6f6f6..f7486d7 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,75 @@ +

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

+ + # 💻 ReVanced CLI +![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/ReVanced/revanced-cli/release.yml) +![GPLv3 License](https://img.shields.io/badge/License-GPL%20v3-yellow.svg) + Command line application to use ReVanced. + +## ❓ About + +ReVanced CLI is a command line application to patch apps using ReVanced. +ReVanced CLI also comes with commands to uninstall or install patched apps and list patches from supplied patch bundles. + +## 🚀 Download + +You can download the most recent version of ReVanced CLI from +[here](https://github.com/ReVanced/revanced-cli/releases/latest). Learn how to use ReVanced CLI by following the [documentation](/docs). + +## 📚 Everything else + +### 📙 Contributing + +Thank you for considering contributing to ReVanced CLI. +You can find the contribution guidelines [here](CONTRIBUTING.md). + +### 🛠️ Building + +In order to build ReVanced CLI, you can follow the [documentation](/docs). + +## 📜 Licence + +ReVanced CLI 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 CLI as long as you track changes/dates in source files. +Any modifications to ReVanced CLI must also be made available under the GPL along with build & install instructions.