From b35b5eba49f3230abad991b43f8fbe958a2fb6b2 Mon Sep 17 00:00:00 2001 From: nin0dev Date: Sat, 23 Mar 2024 07:58:25 -0400 Subject: [PATCH] Update README.md --- README.md | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 90e3b2a..a00683d 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,29 @@ # Vendroid +> [!WARNING] +> This app is still in beta. Before reporting a bug to Vencord support, please attempt to reproduce the bug on: +> - A mobile browser without Vencord by opening `discord.com/app` +> - If the issue still happens on mobile browser, it is likely a mobile website issue. You can open an issue here. +> - A desktop with an official build of Vencord +> - If the issue still happens on a desktop device with Vencord, it is a Vencord issue and you can report it in the [Vencord](https://discord.gg/vencord) server. +> +> If the issue happens on neither of these two, the issue is with Vendroid and you can open an issue in this repo. -Vendroid is a custom Discord client for Android. The way it works is that it loads the discord.com website and injects Vencord. +Vendroid is a custom Discord client for Android. The way it works is that it loads the Discord mobile and injects Vencord. | | | |:--:|:--:| -|![image](https://github.com/Vencord/Vendroid/assets/45497981/e6464167-78b1-4f38-8e96-bb355ea5bbc3)|![image](https://github.com/Vencord/Vendroid/assets/45497981/3f6b278e-f18d-4cae-964f-f357f06ca2bd)| +|![discord homepage](https://github.com/nin0-dev/Vendroid/assets/75569739/488770ea-3331-4979-ba0f-2bd4de964a21)|![photo_5184006040461618491_w](https://github.com/nin0-dev/Vendroid/assets/75569739/c01a01b8-2dab-4126-a20b-7cd4d0d394cc)| +An initial version of Vendroid was made by [Vendicated](https://github.com/Vendicated), [Wing](https://github.com/wingio), and [Xinto](https://github.com/X1nto). However, it is no longer actively maintained. This project has as goal to improve upon the original Vendroid app. +As the Discord website has some annoying bugs, this app isn't 100% stable. I (nin0dev) plan on making patches to enable missing features and improve broken ones. -Discord's mobile site is not very usable since it has many issues. As such, this is mostly just a proof of concept and is not really maintained. +However, if you currently want to use a mobile mod, you can use [Aliucord](https://github.com/Aliucord/Aliucord), which is based on the pre-React Native version of Discord or [Bunny](https://github.com/pyoncord/Pyoncord), that is a Vendetta fork. -You are likely better off using [Aliucord](https://github.com/Aliucord/Aliucord) or [Vendetta](https://github.com/vendetta-mod/Vendetta), that are proper mods of the old and new Discord Android app respectively +## Roadmap + +You can find a roadmap of upcoming features [here](https://github.com/users/nin0-dev/projects/1). You can make issues in this repo to suggest features. ## Download -Visit the [latest release](https://github.com/Vencord/Vendroid/releases/latest), grab the apk and install it +Soon™