From 3c524f1918a22e5141789184486adb9a74bba6f9 Mon Sep 17 00:00:00 2001
From: Nikhil Badyal <nikhill773384@gmail.com>
Date: Thu, 18 Aug 2022 09:11:25 +0530
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Updated=20Documentation?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 55 ++++++++++++++++++++++++++++++++++++++++---------------
 1 file changed, 40 insertions(+), 15 deletions(-)

diff --git a/README.md b/README.md
index d3fe21d..9fdefa0 100644
--- a/README.md
+++ b/README.md
@@ -8,26 +8,51 @@ You can use any of the following methods to build
    2. Run script with
    ```shell
    docker-compose up
-  ```
+   ```
 - Without Docker
    1. Install Java17 (zulu preferred)
    2. Install Python
+   3. Create virtual environment
+      ```python
+      python3 -m venv venv
+      ```
+   4. Activate virtual environment
+      ```python
+      source venv/bin/activate
+      ```
    3. Install Dependencies with
-   ```python
-   pip install -r requirements.txt
-  ```
+      ```python
+      pip install -r requirements.txt
+      ```
    4. Run the script with
-   ```python
-   python main.py
-  ```
+      ```python
+       python main.py
+      ```
 ## Note
-By default script build the version as recommended by revanced team. If you want to
-build and unsupported version and do experiments. Add the version in .env file like
-```dotenv
-YOUTUBE_VERSION=17.31.36
-YOUTUBE-MUSIC_VERSION=X.X.X
-TWITTER_VERSION==X.X.X
-REDDIT_VERSION==X.X.X
-```
+By default script build the version as recommended by revanced team.
+1. If you want to a specific version . Add the version in .env file like
+    ```dotenv
+    YOUTUBE_VERSION=17.31.36
+    YOUTUBE_MUSIC_VERSION=X.X.X
+    TWITTER_VERSION==X.X.X
+    REDDIT_VERSION==X.X.X
+    TIKTOK_VERSION=X.X.X
+    WARNWETTER_VERSION=X.X.X
+    ```
+2. If you want to a `latest` version, whatever latest is available(including beta) .
+   Add the version in .env file like
+    ```dotenv
+    YOUTUBE_VERSION=latest
+    YOUTUBE_MUSIC_VERSION=latest
+    TWITTER_VERSION==latest
+    REDDIT_VERSION==latest
+    TIKTOK_VERSION=latest
+    WARNWETTER_VERSION=latest
+    ```
+3. By default it will build all build app supported by revanced team. If you don't
+   want to waste time and build only few apps. Add following environment variable.
+    ```dotenv
+    PATCH_APPS=youtube,twitter,reddit
+    ```
 ### Note
 Thanks to [@aliharslan0](https://github.com/aliharslan0/pyrevanced) for his work.