From 97ff4e407555bf00b5a997ee65994f9aedc827d0 Mon Sep 17 00:00:00 2001
From: Himadri Bhattacharjee <107522312+lavafroth@users.noreply.github.com>
Date: Tue, 23 Dec 2025 09:24:07 +0530
Subject: [PATCH] docs: add readme

---
 README.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6a42eb9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# Zilch
+
+Purge Android bloat with confidence.
+
+> [!WARNING]  
+> This app is not production ready, some features are missing.
+
+## Features
+
+### Simple UI
+
+- Click on app entries to select them
+- Double click to expand
+- Clear multi-selection by pressing `Escape`
+- Press `S` or `/` to search apps (not yet implemented)
+- Save the current configuration with `Ctrl` + `S` (not yet implemented)
+- Switch categories with `Ctrl` + `Tab` (not yet implemented)
+- Extracts app labels via package manager API
+- Architecture independent, works with any Android device over USB
+- Accidentally removed apps can be restored via the revert button
+
+### Not yet implemented
+
+- [ ] Save button + shortcut
+- [ ] Recommendation categories (WIP)
+- [ ] Make uninstall and disable options depend on Android SDK
+
+### Build from source
+
+```sh
+nix develop
+cargo run
+```