docs: improve README with badges, TOC, and features table
This commit is contained in:
parent
ddeb9bc332
commit
8bbd418812
25
README.md
25
README.md
|
|
@ -1,14 +1,29 @@
|
|||
# Android Reverse Engineering & API Extraction — Claude Code skill
|
||||
|
||||
[](https://opensource.org/licenses/Apache-2.0) [](https://github.com/SimoneAvogadro/android-reverse-engineering-skill/stargazers) [](https://github.com/SimoneAvogadro/android-reverse-engineering-skill/commits/master)
|
||||
|
||||
A Claude Code skill that decompiles Android APK/XAPK/JAR/AAR files and **extracts the HTTP APIs** used by the app — Retrofit endpoints, OkHttp calls, hardcoded URLs, authentication patterns — so you can document and reproduce them without the original source code.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [What it does](#what-it-does)
|
||||
- [Requirements](#requirements)
|
||||
- [Installation](#installation)
|
||||
- [Usage](#usage)
|
||||
- [Repository Structure](#repository-structure)
|
||||
- [References](#references)
|
||||
- [Disclaimer](#disclaimer)
|
||||
- [License](#license)
|
||||
|
||||
## What it does
|
||||
|
||||
- **Decompiles** APK, XAPK, JAR, and AAR files using jadx and Fernflower/Vineflower (single engine or side-by-side comparison)
|
||||
- **Extracts and documents APIs**: Retrofit endpoints, OkHttp calls, hardcoded URLs, auth headers and tokens
|
||||
- **Traces call flows** from Activities/Fragments through ViewModels and repositories down to HTTP calls
|
||||
- **Analyzes** app structure: manifest, packages, architecture patterns
|
||||
- **Handles obfuscated code**: strategies for navigating ProGuard/R8 output
|
||||
| Capability | Description |
|
||||
|------------|-------------|
|
||||
| **Decompile** | APK, XAPK, JAR, and AAR files using jadx and Fernflower/Vineflower (single engine or side-by-side comparison) |
|
||||
| **Extract APIs** | Retrofit endpoints, OkHttp calls, hardcoded URLs, auth headers and tokens |
|
||||
| **Trace call flows** | From Activities/Fragments through ViewModels and repositories down to HTTP calls |
|
||||
| **Analyze structure** | Manifest, packages, architecture patterns |
|
||||
| **Handle obfuscation** | Strategies for navigating ProGuard/R8 output |
|
||||
|
||||
## Requirements
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue