From 9cebaec2053ad071bf2ac88743ab6f8b800dc7bc Mon Sep 17 00:00:00 2001 From: rii <88538677+riivx@users.noreply.github.com> Date: Sun, 11 Feb 2024 19:15:06 +0200 Subject: [PATCH] docs: add new installation method and info (#4) --- README.md | 32 +++++++++++++++++--------------- 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 05903c15..20b04044 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,33 @@ # Revenge A modification for the Discord Android app. Continuation of [Vendetta](https://github.com/vendetta-mod). Get it? Vendetta is like, revenging..., yeah. +> [!WARNING] +> Revenge is still WIP! Please understand that you might encounter some issues. ## ⬇️ Installing > [!NOTE] -> While Revenge is platform-agnostic, there is no guarantee it will always work on iOS. I do not have a device to test the changes I've made, so feel free to report iOS-specific issues in the Issues tab if you encounter one. - -1. Install [Vendetta](https://github.com/vendetta-mod/Vendetta) -2. Go to **Settings** > **General** enable **Developer Settings** -3. Go to **Settings** > **Developer**, enable **Load from custom URL**, and input - ``` - https://cdn.jsdelivr.net/gh/revenge-mod/builds@main/revenge.js - ``` - in the new input box labelled **VENDETTA URL**. - - If the **Developer** settings section does not appear, restart the app -5. Restart the app and check if it says Revenge in the settings - +> While Revenge is platform-agnostic, there is no guarantee it will always work on iOS. I do not have a device to test the changes I've made, so feel free to report iOS-specific issues if you encounter one. + +1. Install [Vendetta Manager](https://github.com/vendetta-mod/VendettaManager/releases/latest/download/Manager.apk) +2. Download (don't install!) the latest [Xposed module](https://github.com/revenge-mod/RevengeXposed/releases/latest/download/app-release.apk) +3. Go to Vendetta manager's **Settings > About** and press version number **10 times** +4. Set the custom Xposed module location to: +``` +/storage/emulated/0/Download/app-release.apk +``` +> [!NOTE] +> This is default location of module if you use *default downloads folder* and *you don't have any `app-release.apk` saved*. If you move module or it has different name - change the path respectively. +5. Head back to main screen and install! ## 💖 Contributing -> [!IMPORTANT] +> [!NOTE] > This project now uses [Bun](https://bun.sh) instead of Node.js. > It is **recommended** to use Bun over Node.js because Bun is faster and far better for development. > -> If you're on Windows, we recommend checking out WSL. +> If you're on Windows, we recommend checking out [WSL](https://github.com/MicrosoftDocs/WSL). -1. Follow the first two steps listed [**⬇️ Installing**](#-installing) section +1. Follow the first two steps listed in [**⬇️ Installing**](#%EF%B8%8F-installing) section 2. Clone the repository ```