From c82f417f11c06ca99eff20a0bbf596321cdb9db1 Mon Sep 17 00:00:00 2001 From: Nikhil Badyal Date: Mon, 15 Aug 2022 17:22:24 +0530 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Added=20Docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0ac6bf0..d3fe21d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,33 @@ # Docker Py ReVanced This little utility will help you in building all revanced apps. +## Build +You can use any of the following methods to build +- With Docker + 1. Install Docker + 2. Run script with + ```shell + docker-compose up + ``` +- Without Docker + 1. Install Java17 (zulu preferred) + 2. Install Python + 3. Install Dependencies with + ```python + pip install -r requirements.txt + ``` + 4. Run the script with + ```python + python main.py + ``` ## Note -Thanks to [@aliharslan0](https://github.com/aliharslan0/pyrevanced) for his work.. +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 +``` +### Note +Thanks to [@aliharslan0](https://github.com/aliharslan0/pyrevanced) for his work.