Skip to content

Commit 8efaa32

Browse files
authored
Update README.md
1 parent b7a2670 commit 8efaa32

1 file changed

Lines changed: 59 additions & 15 deletions

File tree

README.md

Lines changed: 59 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
1-
# <img src="https://github.com/user-attachments/assets/8ed6acde-46c9-43e0-a68c-905bec182234" align="center" width="60" height="60"> QuickEdit - Photo Editor
2-
QuickEdit is a user-friendly photo editor for Android, built using **Jetpack Compose**. It offers essential photo editing tools with a clean and smooth interface.
3-
4-
## Latest Release
5-
6-
[![Release v1.1.0](https://img.shields.io/github/v/release/Abizer-R/QuickEdit-Photo-Editor)](https://github.com/Abizer-R/QuickEdit-Photo-Editor/releases/tag/v1.1.0-4)
7-
8-
- [Download from the Google Play Store](https://play.google.com/store/apps/details?id=com.abizer_r.quickedit)
9-
- [Download Apk (v1.1.0)](https://github.com/Abizer-R/QuickEdit-Photo-Editor/releases/download/v1.1.0-4/app-release.apk)
10-
11-
12-
## [Click Here To Watch Demo Video](https://drive.google.com/file/d/18IipYR_jbUQVFL8U1jNEJd_KTm_Y9ije/view?usp=sharing)
1+
## ⚠️ Partial Readme (Will be updated after draw tool is completed)
2+
---
3+
# <img src="https://github.com/user-attachments/assets/8ed6acde-46c9-43e0-a68c-905bec182234" align="center" width="60" height="60"> QuickEdit - Photo Editor (Compose, Modular, Pluggable)
134

5+
[![Release](https://img.shields.io/github/v/release/Abizer-R/QuickEdit-Photo-Editor)](https://github.com/Abizer-R/QuickEdit-Photo-Editor/releases)
6+
[![Min SDK](https://img.shields.io/badge/minSdk-24-blue)](#)
7+
[![Target SDK](https://img.shields.io/badge/targetSdk-35-blue)](#)
8+
[![License](https://img.shields.io/badge/license-Apache--2.0-green)](#license)
149

10+
**QuickEdit** is a modular, pluggable photo editor for Android with a **stable core engine**, a **Compose UI shell**, and **tool plugins** (Crop ✅, Draw/Text/Effects scaffolds).
11+
It preserves legacy UX (slide-out editor bars → full-screen tools) while cleaning layering, performance, and testability.
1512

13+
- 📱 **Play Store:** [Install](https://play.google.com/store/apps/details?id=com.abizer_r.quickedit)
14+
- 📦 **Latest APK:** [Releases](https://github.com/Abizer-R/QuickEdit-Photo-Editor/releases)
1615

1716
<div style="display: flex; flex-wrap: wrap; gap: 10px; align-items: flex-start;">
1817
<img src="https://github.com/user-attachments/assets/78217ce9-4771-4db0-9dae-345214eb28f1" alt="1" width="200" />
@@ -35,16 +34,61 @@ QuickEdit is a user-friendly photo editor for Android, built using **Jetpack Com
3534
- **Add Text**: Add text with option to customize fonts and format (bold, italic and more).
3635
- **Smooth Animations**: Enjoy a seamless experience thanks to Jetpack Compose.
3736

37+
---
38+
39+
## Architecture (v0.x)
40+
41+
**Goal:** a reusable editor published as Maven artifacts with a stable engine API and pluggable tools.
42+
**Status:** engine + shell done; Crop tool delivered; Draw in progress; Effects & Text planned.
43+
44+
## Modules & Dependency Rules
45+
46+
```
47+
app-sample/ # Host app; exercises the library
48+
quickedit/ # Legacy façade (keeps old entrypoints stable)
49+
quickedit-core-engine/ # Engine API + default impl (no Compose/UI deps)
50+
quickedit-compose-ui/ # Shell + tool contracts (Compose UI, no tool logic)
51+
quickedit-tool-crop/ # Crop tool (full-screen)
52+
quickedit-tool-draw/ # (ongoing)
53+
quickedit-tool-text/ # (planned)
54+
quickedit-tool-effects/ # (planned)
55+
```
56+
57+
### **Dependency graph (enforced):**
58+
```
59+
app-sample ──► quickedit (legacy)
60+
├──► quickedit-compose-ui ──api──► quickedit-core-engine
61+
└──► quickedit-tool-*
62+
quickedit-tool-* ──► quickedit-compose-ui
63+
quickedit-core-engine (Android framework only; no UI)
64+
```
65+
66+
**Why `api(..)` from UI → Engine?** The UI public API mentions engine types (`EditImage`, `SaveFormat`). Re-exporting via `api(project(":quickedit-core-engine"))` makes those types visible to consumers cleanly.
67+
68+
69+
## Tech Stack & Versions (from `libs.versions.toml`)
70+
71+
- **Android:** minSdk 24 · target/compile 35 · JDK 17
72+
- **Gradle/AGP:** 8.6.1
73+
- **Kotlin:** 2.1.10 (+ Compose plugin)
74+
- **Compose BOM:** 2025.05.00
75+
- **Compose libs:** Material3, Animation `1.7.0-beta04`, UI/Test/Tooling
76+
- **AndroidX:** Activity Compose 1.9.0 · Lifecycle 2.8.2 · Navigation 2.7.7 · AppCompat 1.7.0 · Core-ktx 1.13.1
77+
- **DI:** Hilt 2.57.1 (with hilt-navigation-compose 1.2.0)
78+
- **Coroutines:** 1.10.1
79+
- **Imaging:** GPUImage 2.1.0 · CanHub Cropper 4.5.0 · Compose-Screenshot 1.0.3
80+
- **UX Utils:** Cloudy 0.2.7 · ColorPicker 1.0.0
81+
- **Testing:** JUnit 4.13.2 · AndroidX JUnit 1.2.0 · Espresso 3.6.0
82+
83+
---
84+
3885
## Libraries Used
3986

4087
QuickEdit makes use of the following libraries to provide its features:
4188

4289
- **Jetpack Compose**: A modern toolkit for building native Android UI.
4390
- **Compose Animations**: For smooth and customizable UI animations.
44-
- **[GPUImage](https://github.com/CyberAgent/android-gpuimage)**: A library for GPU-based image processing by CyberAgent.
45-
- **[Cloudy](https://github.com/skydoves/cloudy)**: A library by Skydoves for blurring a composable.
4691
- **[Image Cropper](https://github.com/CanHub/Android-Image-Cropper)**: A cropping library by Canhub that allows users to crop images seamlessly.
47-
- **[Compose-Screenshot](https://github.com/SmartToolFactory/Compose-Screenshot)**: A library by SmartToolFactory for capturing screenshots of composables in Jetpack Compose.
4892

4993

5094
# License

0 commit comments

Comments
 (0)