From 0a5710ab3ff16eadf53a215b082c67823906bc2d Mon Sep 17 00:00:00 2001
From: Michael <20937441+KMikeeU@users.noreply.github.com>
Date: Thu, 9 Jul 2026 14:12:31 +0200
Subject: [PATCH] docs: update readme

---
 README.md | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)

diff --git a/README.md b/README.md
index 477b0fe..0e47df3 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,42 @@
 # Android Reverse Engineering (ARE)
 
+> Note: this is WIP and only works on Windows as of now
+
+## Installation
+```
+uv tool install .
+```
+
+Requirements:
+- adb
+- apktool
+- uber-apk-signer
+
+## Usage
+
+### Initialize project
+```shell
+are init com.mypackage
+```
+> Note: This will attempt to rip the specified package from a connected device
+
+### Manually copy package
+This will copy a package from a connected device via adb, including all split apks.
+```shell
+are rip
+```
+
+### Working with packages
+```shell
+# Run this from the version directory created by `are rip`
+are decompile
+
+# Rebuild with patches
+are build
+
+# Sign with default debug keystore
+are sign
+
+# Install (possibly split) apk
+are install
+```