RomanNum3ral
/
for-android
mirror of https://github.com/stoatchat/for-android.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: update readme 

Signed-off-by: Infi <infi@infi.sh>
This commit is contained in:
Infi 2025-08-21 19:43:30 +02:00
parent 9cd738fdce
commit 2e5a3f32da
1 changed files with 11 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -1,21 +1,12 @@
# Revolt on Android
# Revolt for Android
## Description
This is the official Android app for the [Revolt](https://revolt.chat) chat platform.
Official [Revolt](https://revolt.chat) Android app
The codebase includes the app itself, as well as an internal library for interacting with the Revolt
API.
| Module | Package | Description |
|--------|---------------|----------------------|
| `:app` | `chat.revolt` | The main app module. |
The API library is part of the `app` module, and is not intended to be used as a standalone library,
as it makes liberal use of Android-specific APIs for reactivity.
The app is written in Kotlin, and uses
the [Jetpack Compose](https://developer.android.com/jetpack/compose) UI toolkit, the current state
of the art for Android UI development.
API. The app is written in Kotlin, and wholly
uses [Jetpack Compose](https://developer.android.com/jetpack/compose).
## Stack
@ -29,9 +20,10 @@ of the art for Android UI development.
## Resources
### Revolt on Android
### Revolt for Android
- [Revolt on Android Technical Documentation](https://revoltchat.github.io/android/)
- [Roadmap](https://op.revolt.wtf/projects/revolt-for-android/work_packages)
- [Revolt for Android Technical Documentation](https://revoltchat.github.io/android/)
- [Android-specific Contribution Guide](https://revoltchat.github.io/android/contributing/guidelines/)
&mdash;**read carefully before contributing!**
@ -39,8 +31,9 @@ of the art for Android UI development.
- [Revolt Project Board](https://github.com/revoltchat/revolt/discussions) (Submit feature requests
here)
- [Revolt Testers Server](https://app.revolt.chat/invite/Testers)
- [General Revolt Contribution Guide](https://developers.revolt.chat/contributing)
- [Revolt Development Server](https://app.revolt.chat/invite/API)
- [Revolt Server](https://app.revolt.chat/invite/Testers)
- [General Revolt Contribution Guide](https://developers.revolt.chat/contrib.html)
## Quick Start