diff --git a/README.md b/README.md index a221f35..691f661 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,50 @@ -# @revenge-mod/revenge +
-To install dependencies: +# Revenge -```bash -bun install -``` +**Discord, your way.** Revenge is a client modification for Discord Android. -To run: +Revenge aims to be a lightweight and lightning-fast client modification for Discord Android, while being user-friendly and developer-first. It provides a powerful framework, allowing developers to make add-ons with ease. The sky is the limit! -```bash -bun run src/index.ts -``` +## ❓ About -This project was created using `bun init` in bun v1.2.2. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime. +This repository releases Hermes Bytecode to be executed on official Discord Android clients. The bytecode is not standalone and is meant to be used with official bootstrappers listed in the [⬇️ Download](#️-download) section. + +## 💪 Features + +- **🔌 Plugins**: Extend Discord with custom features +- **🎨 Themes & Fonts**: Customize Discord's appearance to your liking +- **🧪 Experiments**: Try out Discord's new features before they're rolled out + +## ⬇️ Download + +These are the official Revenge ways to install Revenge: + +- **📵 Non-root**: [Revenge Manager](https://github.com/revenge-mod/revenge-manager/releases/latest) +- **🩹 Root with Xposed**: [RevengeXposed](https://github.com/revenge-mod/revenge-xposed/releases/latest)