chore: merge branch dev to main (#192)

.github/workflows/pull_request.yml

@@ -11,6 +11,7 @@ env:
 
 jobs:
   pull-request:
+    name: Open pull request
     runs-on: ubuntu-latest
     steps:
       - name: Checkout

.github/workflows/release.yml

@@ -1,4 +1,5 @@
 name: Release
+
 on:
   workflow_dispatch:
   push:
@@ -9,6 +10,7 @@ on:
     branches:
       - main
       - dev
+
 jobs:
   release:
     name: Release
@@ -30,7 +32,7 @@ jobs:
           node-version: "latest"
           cache: 'npm'
       - name: Setup semantic-release
-        run: npm install semantic-release @saithodev/semantic-release-backmerge @semantic-release/git @semantic-release/changelog gradle-semantic-release-plugin -D
+        run: npm install semantic-release@19.0.5 @saithodev/semantic-release-backmerge @semantic-release/git @semantic-release/changelog gradle-semantic-release-plugin@1.7.4 -D
       - name: Create release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/update-documentation.yml

@@ -0,0 +1,18 @@
+name: Update documentation
+
+on:
+  push:
+    paths:
+      - docs/**
+
+jobs:
+  trigger:
+    runs-on: ubuntu-latest
+    name: Dispatch event to documentation repository
+    steps:
+      - uses: peter-evans/repository-dispatch@v2
+        with:
+          token: ${{ secrets.DOCUMENTATION_REPO_ACCESS_TOKEN  }}
+          repository: revanced/revanced-documentation
+          event-type: update-documentation
+          client-payload: '{"repo": "${{ github.event.repository.name }}", "ref": "${{ github.ref }}"}'

docs/0_prerequisites.md

@@ -0,0 +1,17 @@
+# 💼 Prerequisites
+
+To use the ReVanced CLI, you will need to fulfill certain requirements.
+
+## 🤝 Requirements
+
+- [Android Debug Bridge (adb)](https://developer.android.com/studio/command-line/adb), the command-line tool that lets
+  you communicate with a device (optional).
+- A x86/x86_64 host (or a custom AAPT binary for your architecture)
+- Zulu OpenJDK 17
+- An APK file (e.g. YouTube v17.49.37 or YouTube Music v5.36.51)
+
+## ⏭️ Whats next
+
+The next section will show, how to use the [ReVanced CLI](https://github.com/revanced/revanced-cli).
+
+Continue: [🛠️ Using the ReVanced CLI](1_usage.md)

docs/1_usage.md

@@ -0,0 +1,75 @@
+# 🛠️ Using the ReVanced CLI
+
+Lean how to use the ReVanced CLI.
+
+## ⚡ Setup (optional)
+
+1. Make sure your device is connected
+
+   ```bash
+   adb shell exit
+   ```
+
+   If you plan to use the root variant, check if you have root access
+
+   ```bash
+   adb shell su -c exit
+   ```
+
+2. Copy the ADB device name
+
+   ```bash
+   adb devices
+   ```
+
+## 🔨 ReVanced CLI Usage
+
+- ### Show all available options for the ReVanced CLI
+
+  ```bash
+  java -jar revanced-cli.jar -h
+  ```
+
+- ### List all available patches from supplied patch bundles
+
+  ```bash
+  java -jar revanced-cli.jar \
+      -b revanced-patches.jar \
+      -l
+  ```
+
+- ### Use the ReVanced CLI without root permissions
+
+  ```bash
+  java -jar revanced-cli.jar \
+   -a input.apk \
+   -c \
+   -o unpatched-output.apk \
+   -b revanced-patches.jar
+  ```
+
+- ### Mount the patched application with root permissions over the installed application
+
+  ```bash
+  adb install input.apk # make sure the same version is installed
+  java -jar revanced-cli.jar \
+      -a input.apk \
+      -c \
+      -d device-name \
+      -o patched-output.apk \
+      -b revanced-patches.jar \
+      -e microg-support \
+      --mount
+  ```
+
+> **Note**:
+>
+> - If you want to exclude patches, you can use the option `-e`. In the case of YouTube, you have to exclude
+    the `microg-support` patch from  [ReVanced Patches](https://github.com/revanced/revanced-patches) with the
+    option `-e microg-support`.
+>
+> - Some patches from [ReVanced Patches](https://github.com/revanced/revanced-patches) also might require
+    [ReVanced Integrations](https://github.com/revanced/revanced-integrations). Supply them with the option `-m`.
+>
+> - If you supplied a device with the option `-d`, the patched application will be automatically installed on the
+    device.

docs/README.md

@@ -0,0 +1,8 @@
+# 💻 Documentation and guides of ReVanced CLI
+
+This documentation explain, how to use the [ReVanced CLI](https://github.com/revanced/revanced-cli).
+
+## 📖 Table of contents
+
+1. [💼 Prerequisites](0_prerequisites.md)
+2. [🛠️ Using the ReVanced CLI](1_usage.md)