From 19200eacc1e4cbf245aa10cb22f2a6677cff6b36 Mon Sep 17 00:00:00 2001
From: oSumAtrIX <johan.melkonyan1@web.de>
Date: Sun, 8 Jan 2023 14:37:10 +0100
Subject: [PATCH 1/2] docs: init

---
 docs/0_prerequisites.md | 17 ++++++++++
 docs/1_usage.md         | 74 +++++++++++++++++++++++++++++++++++++++++
 docs/README.md          |  8 +++++
 3 files changed, 99 insertions(+)
 create mode 100644 docs/0_prerequisites.md
 create mode 100644 docs/1_usage.md
 create mode 100644 docs/README.md

diff --git a/docs/0_prerequisites.md b/docs/0_prerequisites.md
new file mode 100644
index 0000000..c802b25
--- /dev/null
+++ b/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)
diff --git a/docs/1_usage.md b/docs/1_usage.md
new file mode 100644
index 0000000..e600e8b
--- /dev/null
+++ b/docs/1_usage.md
@@ -0,0 +1,74 @@
+# 🛠️ Using the ReVanced CLI
+
+Lean how to use the ReVanced CLI.
+
+## ⚡ Setup
+
+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 inside supplied 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
+  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 the [ReVanced Patches](https://github.com/revanced/revanced-patches) with the
+    option `-e microg-support`.
+>
+> - Some patches from the [ReVanced Patches](https://github.com/revanced/revanced-patches) also might require
+    the [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.
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..a4d2749
--- /dev/null
+++ b/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)

From 6bd7d42e32450974a52e1bb9df4a31512d399842 Mon Sep 17 00:00:00 2001
From: oSumAtrIX <johan.melkonyan1@web.de>
Date: Sun, 8 Jan 2023 14:46:13 +0100
Subject: [PATCH 2/2] ci: dispatch event to `revanced/revanced-documentation`
 on push to `/docs`

---
 .github/workflows/update-documentation.yml | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 .github/workflows/update-documentation.yml

diff --git a/.github/workflows/update-documentation.yml b/.github/workflows/update-documentation.yml
new file mode 100644
index 0000000..aa0ed1b
--- /dev/null
+++ b/.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 }}"}'