Skip to content

Commit

Permalink
docs: Add features and documentation section to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
oSumAtrIX committed Feb 26, 2024
1 parent e622616 commit 628b452
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,13 +67,23 @@ Command line application to use ReVanced.

## ❓ About

ReVanced CLI is a command line application that patches apps using ReVanced.
ReVanced CLI also has commands to uninstall or install patched apps and list patches from supplied patch bundles.
ReVanced CLI is a command line application that uses [ReVanced Patcher](https://github.com/revanced/revanced-patcher) to patch Android apps.

## πŸš€ Download
## πŸ’ͺ Features

Some of the features ReVanced CLI provides are:

- πŸ’‰ **Patch apps**: Harness ReVanced Patcher to patch Android apps
- πŸ’Ύ **Install and uninstall apps**: Install and uninstall Apps via ADB,
using the Android package manager, or by mounting using root permissions
- πŸ“ƒ **List patches from patch bundles**: List available patches, compatible packages, and versions
- πŸ’ͺ **Flexibility and functionality**: Apply any combination of patches to any version of Android apps

## πŸ”½ Download

You can download the most recent version of ReVanced CLI from
[here](https://github.com/ReVanced/revanced-cli/releases/latest). Use ReVanced CLI by following the [documentation](/docs).
[here](https://github.com/ReVanced/revanced-cli/releases/latest).
Learn how to use ReVanced CLI by following the [documentation](/docs).

## πŸ“š Everything else

Expand All @@ -86,6 +96,10 @@ You can find the contribution guidelines [here](CONTRIBUTING.md).

To build a ReVanced CLI, you can follow the [documentation](/docs).

### πŸ“ƒ Documentation

You can find the documentation of ReVanced CLI [here](/docs).

## πŸ“œ Licence

ReVanced CLI is licensed under the GPLv3 license. Please see the [license file](LICENSE) for more information.
Expand Down

0 comments on commit 628b452

Please sign in to comment.