From c0e08c8b8cc35f3ec713d023194e2ce702e61b25 Mon Sep 17 00:00:00 2001 From: PalmDevs Date: Sun, 15 Sep 2024 19:29:54 +0700 Subject: [PATCH] chore(README): update strings --- README.md | 42 +++++++++++++++++++++++++----------------- 1 file changed, 25 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 54a60919..41132d9a 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,42 @@ -# Bunny [![Discord](https://img.shields.io/discord/1196075698301968455?style=social&logo=discord&label=Pyoncord)](https://discord.gg/XjYgWXHb9Q) -A mod for Discord's mobile apps, a fork of [Vendetta](https://github.com/vendetta-mod/Vendetta/). +# Revenge [![Discord](https://img.shields.io/discord/1205207689832038522?style=social&logo=discord&label=Revenge)]([https://discord.gg/24Ue3pzaum]) +A modification for Discord's mobile apps, a fork of [Bunny](https://github.com/pyoncord/Bunny). ## Installing ### Android -- **Root** with Xposed - [BunnyXposed](https://github.com/pyoncord/BunnyXposed/releases/latest) -- **Non-root** - [BunnyManager](https://github.com/pyoncord/BunnyManager/releases/latest) +- **Root** with Xposed - [RevengeXposed](https://github.com/revenge-mod/RevengeXposed/releases/latest) +- **Non-root** - [Revenge Manager](https://github.com/revenge-mod/RevengeManager/releases/latest) ### iOS -- [**BunnyTweak**](https://github.com/pyoncord/BunnyTweak) - Get prebuilt rootful and rootless `.deb` files or the prepatched `.ipa ` +- [**RevengeTweak**](https://github.com/revenge-mod/RevengeTweak) - Get prebuilt rootful and rootless `.deb` files or the prepatched `.ipa ` ## Building -1. Install a Bunny loader with loader config support (any mentioned in the [Installing](#installing) section). -1. Go to Settings > General and enable Developer Settings. -1. Clone the repo: - ``` - git clone https://github.com/pyoncord/Bunny +1. Install a Revenge loader with config support (any mentioned in the [Installing](#installing) section). +2. Go to **Settings** > **General** and enable **Developer Settings**. +3. Clone the repository + + ```sh + git clone https://github.com/revenge-mod/Revenge.git ``` -1. Install dependencies: + +4. Install dependencies + ``` pnpm i ``` -1. Build Bunny's code: + +5. Build Revenge's code + ``` pnpm build ``` -1. In the newly created `dist` directory, run a HTTP server. I recommend [http-server](https://www.npmjs.com/package/http-server). -1. Go to Settings > Developer enabled earlier. Enable `Load from custom url` and input the IP address and port of the server (e.g. `http://192.168.1.236:4040/bunny.js`) in the new input box labelled `Bunny URL`. -1. Restart Discord. Upon reload, you should notice that your device will download Bunny's bundled code from your server, rather than GitHub. -1. Make your changes, rebuild, reload, go wild! -Alternatively, you can directly *serve* the bundled code by running `pnpm serve`. `bunny.js` will be served on your local address under the port 4040. You will then insert `http://:4040/bunny.js` as a custom url and reload. Whenever you restart your mobile client, the script will rebuild the bundle as your client fetches it. +6. In the newly created `dist` directory, run a HTTP server. I recommend [http-server](https://www.npmjs.com/package/http-server). +7. Go to **Settings** > **Developer** enabled earlier. Enable `Load from custom URL` and input the IP address and port of the server (e.g. `http://192.168.1.236:4040/revenge.js`) in the new input box labeled `Revenge URL`. +8. Restart Discord. Upon reload, you should notice that your device will download Revenge's bundled code from your server, rather than GitHub. +9. Make your changes, rebuild, reload, go wild! + +Alternatively, you can directly *serve* the bundled code by running `pnpm serve`. `revenge.js` will be served on your local address under the port 4040. You will then insert `http://:4040/revenge.js` as a custom URL and reload. Whenever you restart your mobile client, the script will rebuild the bundle as your client fetches it. + +If the bundle keeps being cached and not updated, you can instead tap the **Settings** > **Developer** > **Clear JS bundle** option which will prompt you to reload.