[Docs] Update README.md

CaZaIt · Jan 26, 2023 · 3e1a520 · 3e1a520
1 parent 8c024b0
commit 3e1a520
Showing 1 changed file with 43 additions and 1 deletion.
diff --git a/docs/README.md b/docs/README.md
@@ -1 +1,43 @@
-# CaZaIt-Android
+CaZaIt-Android
+==================
+UMC 3th Team Cazait
+
+## Features
+* Room Database
+* Hilt
+* ViewModel
+* Navigation
+* Repository and data source
+
+## Package Structure
+```
+cazait_android
+    ├─ data
+    │  ├─ api
+    │  ├─ dto
+    │  │  └─ login
+    │  ├─ error
+    │  │  └─ mapper
+    │  ├─ model
+    │  │  ├─ local
+    │  │  └─ remote
+    │  └─ repository
+    ├─ di
+    ├─ network
+    ├─ ui
+    │  ├─ adapter
+    │  ├─ base
+    │  ├─ util
+    │  │  └─ extension
+    │  ├─ view
+    │  │  ├─ cafelist
+    │  │  │  └─ info
+    │  │  │      └─ inner
+    │  │  ├─ login
+    │  │  ├─ mypage
+    │  │  ├─ signup
+    │  │  └─ splash
+    │  └─ viewmodel
+    └─ usecase
+        └─ errors
+```