From 1e3d064894ce23cc1cb3071cde8b545bf62dc07a Mon Sep 17 00:00:00 2001
From: programminghoch10 <16062290+programminghoch10@users.noreply.github.com>
Date: Sat, 3 Jun 2023 18:19:21 +0200
Subject: [PATCH] add documentation

---
 README.md | 49 ++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 48 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 9f706db..3180beb 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,48 @@
-# ReVancedRepackaged
\ No newline at end of file
+# ReVancedRepackaged
+
+**ReVanced, but patched locally.**
+
+This magisk module 
+contains only the ReVanced Patcher.
+It will patch the installed YouTube app 
+right on your device during installation.
+
+![GitHub Latest Release (by date)](https://img.shields.io/github/v/release/programminghoch10/ReVancedRepackaged?label=latest&logo=github&display_name=release)
+![GitHub Latest Release Date](https://img.shields.io/github/release-date/programminghoch10/ReVancedRepackaged?logo=github) \
+![GitHub Global Download Counter](https://img.shields.io/github/downloads/programminghoch10/ReVancedRepackaged/total?logo=github)
+![GitHub Latest Download Counter](https://img.shields.io/github/downloads/programminghoch10/ReVancedRepackaged/latest/total?logo=github) \
+![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/programminghoch10/ReVancedRepackaged/build.yml?logo=github%20actions&logoColor=white)
+![GitHub commits since last release](https://img.shields.io/github/commits-since/programminghoch10/ReVancedRepackaged/latest?logo=git&logoColor=white)
+![GitHub last commit](https://img.shields.io/github/last-commit/programminghoch10/ReVancedRepackaged?logo=git&logoColor=white) \
+![GitHub Repo stars](https://img.shields.io/github/stars/programminghoch10/ReVancedRepackaged?style=social) \
+[![GitHub followers](https://img.shields.io/github/followers/programminghoch10?style=social)](https://github.com/programminghoch10)
+
+## Installation
+
+1. Install the original stock YouTube app.  
+   *Make sure you have the correct version installed before proceeding.*
+1. Install the module and wait for it to patch the YouTube app.  
+   *This might take a while.*
+   *Please refrain from doing anything else on your device in the meantime.*
+1. Go into the Google Play Store and disable automatic app updates for YouTube.
+1. Reboot
+
+## Concept
+
+In most legislations it is illegal to redistribute modified software 
+without consent of the copyright holder.
+
+For example:  
+The Windows modding community isn't allowed to distribute modified Windows ISOs
+but is allowed to distribute a patcher, 
+which the user can download to patch their geniune Windows ISO.
+
+The same concept can be applied to ReVanced.  
+Redistributing magisk modules with the patched YouTube APK is not legal.
+But we are totally fine distributing the patcher 
+and letting the user patch the original APK on his own.
+
+This module automates exactly this.
+You, the user, download the original YouTube APK yourself.
+This module will patch the installed YouTube APK during installation
+**right on your device**.