Skip to content

Commit 628b452

Browse files
committed
docs: Add features and documentation section to readme
1 parent e622616 commit 628b452

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

β€ŽREADME.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,13 +67,23 @@ Command line application to use ReVanced.
6767

6868
## ❓ About
6969

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

73-
## πŸš€ Download
72+
## πŸ’ͺ Features
73+
74+
Some of the features ReVanced CLI provides are:
75+
76+
- πŸ’‰ **Patch apps**: Harness ReVanced Patcher to patch Android apps
77+
- πŸ’Ύ **Install and uninstall apps**: Install and uninstall Apps via ADB,
78+
using the Android package manager, or by mounting using root permissions
79+
- πŸ“ƒ **List patches from patch bundles**: List available patches, compatible packages, and versions
80+
- πŸ’ͺ **Flexibility and functionality**: Apply any combination of patches to any version of Android apps
81+
82+
## πŸ”½ Download
7483

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

7888
## πŸ“š Everything else
7989

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

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

99+
### πŸ“ƒ Documentation
100+
101+
You can find the documentation of ReVanced CLI [here](/docs).
102+
89103
## πŸ“œ Licence
90104

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

0 commit comments

Comments
Β (0)