Skip to content

Commit 8fc276a

Browse files
Revise README for improved clarity and detail
Updated README.md to enhance project description, features, and structure.
1 parent 06485ce commit 8fc276a

1 file changed

Lines changed: 75 additions & 20 deletions

File tree

README.md

Lines changed: 75 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,84 @@
1-
# LeafLens
2-
A SwiftUI-based iOS app that scans objects, matches them with known data, and saves match results.
1+
# 🍃 LeafLens
32

4-
## 🔧 Tech Stack
5-
- ✅ SwiftUI
6-
- ✅ MVVM Architecture
7-
- ✅ CoreML
8-
- ✅ Vision Framework
3+
![iOS CI](https://img.shields.io/badge/iOS-SwiftUI-blue)
4+
![Architecture](https://img.shields.io/badge/Architecture-MVVM-green)
5+
6+
LeafLens is a SwiftUI-based iOS application that detects real-world objects using the device camera, matches them with trained machine learning models, and stores the results for later review.
7+
8+
The project demonstrates practical integration of Vision and CoreML frameworks within a clean MVVM architecture.
9+
10+
---
11+
12+
## ✨ Features
13+
14+
- 📷 Real-time object detection using camera
15+
- 🧠 Smart classification powered by CoreML
16+
- 🔍 Vision framework integration
17+
- 💾 Save and review previous detection results
18+
- 🎨 Clean and responsive SwiftUI interface
19+
- 🏗 Scalable MVVM architecture
20+
21+
---
22+
23+
## 🏗 Architecture
24+
25+
The app follows **MVVM (Model-View-ViewModel)** pattern:
26+
27+
- **Model** → Data structures & ML result mapping
28+
- **View** → SwiftUI UI components
29+
- **ViewModel** → Business logic & Vision/ML handling
30+
31+
This ensures clean separation of concerns and testable logic.
32+
33+
---
34+
35+
## 🛠 Tech Stack
36+
37+
- Swift
38+
- SwiftUI
39+
- Vision Framework
40+
- CoreML
41+
- AVFoundation (Camera handling)
42+
- MVVM Architecture
43+
44+
---
945

1046
## 📸 Preview
1147

1248
![App Preview](Assets/leaflens_preview.png)
1349

14-
> 🔁 Replace `Assets/leaflens_preview.png` with your actual image path in the repo.
50+
> Replace the image path with your actual preview image stored in the repository.
1551
16-
## 📂 Features
17-
- 📷 Object Detection using Camera
18-
- 🧠 Smart Matching using CoreML
19-
- 💾 Save & Review Match Results
20-
- 💡 Intuitive SwiftUI UI/UX
52+
---
2153

22-
## 📦 Folder Structure
23-
```plaintext
54+
## 📂 Project Structure
2455
LeafLens/
25-
├── Models/
26-
├── Views/
27-
├── ViewModels/
28-
├── Resources/
29-
└── Assets.xcassets/
56+
├─ Models/
57+
58+
├─ Views/
59+
60+
├─ ViewModels/
61+
62+
├─ Resources/
63+
64+
└─ Assets.xcassets/
65+
---
66+
67+
## 🚀 Learning Highlights
68+
69+
- Real-time image classification
70+
- Vision + CoreML integration
71+
- Camera pipeline handling
72+
- Clean architecture implementation
73+
- SwiftUI reactive UI updates
74+
75+
---
76+
77+
## 📌 Author
78+
79+
**Navin Rai**
80+
iOS Developer specializing in Swift, SwiftUI, UIKit, and CoreML.
81+
Passionate about building scalable, production-ready iOS applications.
82+
83+
🔗 LinkedIn: https://www.linkedin.com/in/navinkumarrai
84+
💻 GitHub: https://github.com/Navin-Rai-Developer

0 commit comments

Comments
 (0)