feat: new README

README.md

@@ -1,6 +1,72 @@
-# Aliucord Manager [![Crowdin](https://badges.crowdin.net/aliucord-manager/localized.svg)](https://crowdin.com/project/aliucord-manager)
+<div align="center">
+    <img src=".github/assets/manager-preview.png" alt="Aliucord Manager preview" />
+    <h1>Aliucord Manager</h1>
+    <p>The new method to install Aliucord, in a user-friendly way.</p>
 
-Aliucord Manager - Aliucord Installer rewrite in [Kotlin](https://kotlinlang.org)
-and [Jetpack Compose](https://developer.android.com/jetpack/compose).
+[![Discord](https://img.shields.io/discord/811255666990907402?logo=discord&logoColor=white&style=for-the-badge&color=5865F2)](https://discord.gg/EsNDvBaHVU)
+[![GitHub Stars](https://img.shields.io/github/stars/Aliucord/Manager?logo=github&style=for-the-badge&color=ffd663)](https://github.com/Aliucord/Manager/stargazers)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/Aliucord/Manager/build.yml?label=Build&logo=github&style=for-the-badge&branch=main)](https://nightly.link/Aliucord/Manager/workflows/android/main/app.zip)
+![GitHub Downloads](https://img.shields.io/github/downloads/Aliucord/Manager/total?style=for-the-badge&logo=github)
+![Code Size](https://img.shields.io/github/languages/code-size/Aliucord/Manager?logo=github&logoColor=%23fff&style=for-the-badge)
+[![GitHub License](https://img.shields.io/github/license/Aliucord/Manager?style=for-the-badge)](https://github.com/Aliucord/Manager/blob/main/LICENSE)
 
-INFO: This app is not functional yet, if you want to install Aliucord - [read this](https://github.com/Aliucord/Aliucord#-installation)
+</div>
+
+## Prerequisites
+
+Supported Android versions:
+
+- Android 7 (SDK 24) - Android 16 QPR1 (SDK 36)
+- Architectures: arm64, armeabi-v7, x86_64, x86
+
+If you have already installed Aliucord before via the old installer app, you can uninstall the
+legacy installer. It is deprecated and does not work anymore.
+
+## Installation
+
+1. Download the [latest release APK](https://github.com/Aliucord/Manager/releases/latest)
+2. Open and install Aliucord Manager
+    - If you have not enabled "Install from unknown sources" for your browser via system settings, do so now.
+3. Open Aliucord Manager
+4. Grant the permission requests
+5. Click "New Install"
+    - You may change how the Aliucord app icon will look once installed.
+6. Click "Install" and wait. Do not exit the app while it is running.
+    - If a failure occurs, it may be due to a variety of reasons:
+        - Poor internet connection
+        - Internet censorship / blocks (use a VPN or a different DNS server)
+        - Insufficient free storage (at least 500MB is recommended)
+    - If you are stuck, please ask for help in the `#support` channel of our [Discord](https://discord.gg/EsNDvBaHVU0).
+7. Click "Launch" or directly launch the newly installed Aliucord app
+8. Grant the permission requests
+9. Sign in to Discord
+10. Install plugins by following these [instructions](https://github.com/aliucord/aliucord#-plugin-installation)
+
+## Building
+
+1. Install the prerequisites:
+    - Git
+    - [JDK 21+](https://adoptium.net/temurin/releases/?os=any&arch=any&version=21)
+2. Clone the repo:
+   ```shell
+   git clone https://github.com/rushiiMachine/Manager && cd Manager
+   ```
+3. Build the project:
+   #### Linux/macOS
+   ```shell
+   chmod +x gradlew && ./gradlew :app:packageStaging --stacktrace
+   ```
+   #### Windows
+   ```shell
+   .\gradlew.bat app:assembleDebug
+   ```
+4. Built APK will be located at `./app/build/outputs/apk/staging/app-staging.apk`
+
+## Translations
+
+This project handles crowd-sourced translations through Crowdin! If you happen to be fluent in one of the languages listed below,
+then please feel free to contribute your translations!
+
+[![Crowdin Translations](https://badges.crowdin.net/badge/light/crowdin-on-dark.png)](https://crowdin.com/project/aliucord-manager)
+<br/><br/>
+[![Translation Statistics](https://badges.awesome-crowdin.com/translation-15208176-543502.png)](https://crowdin.com/project/aliucord-manager)

TODO.md

@@ -0,0 +1,10 @@
+- Android API 21 support
+- Unified permissions screen like in Aurora Store
+- zip-android 64KiB alignment
+- zip-android faster file deletion
+- Better UI for conflicting package names
+    - Auto-rename package names when adding new installs...?
+- `IconOptionsScreen`
+  - https://discord.com/channels/811255666990907402/1373756392892272691/1380726498725593220
+  - Save/Back button at the bottom
+  - Reset button on PatchOptionsScreen?