chore: add README
This commit is contained in:
parent
af23c2352e
commit
355b780ab4
1 changed files with 45 additions and 10 deletions
55
README.md
55
README.md
|
|
@ -1,15 +1,50 @@
|
|||
# @revenge-mod/revenge
|
||||
<p align="center">
|
||||
<picture>
|
||||
<source
|
||||
width="512px"
|
||||
media="(prefers-color-scheme: dark)"
|
||||
srcset="assets/wordmark/wordmark+slogan-dark.svg"
|
||||
>
|
||||
<img
|
||||
width="512px"
|
||||
src="assets/wordmark/wordmark+slogan-light.svg"
|
||||
>
|
||||
</picture>
|
||||
<br>
|
||||
<a href="https://discord.com/invite/ddcQf3s2Uq">
|
||||
<picture>
|
||||
<source height="32px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
|
||||
<img height="32px" src="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
|
||||
</picture>
|
||||
</a>
|
||||
<a href="https://github.com/revenge-mod">
|
||||
<picture>
|
||||
<source height="32px" media="(prefers-color-scheme: dark)" srcset="https://i.ibb.co/dMMmCrW/Git-Hub-Mark.png" />
|
||||
<img height="32px" src="https://i.ibb.co/9wV3HGF/Git-Hub-Mark-Light.png" />
|
||||
</picture>
|
||||
</a>
|
||||
</a>
|
||||
</p>
|
||||
|
||||
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)
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue