diff --git a/docs/README.md b/docs/README.md index 92cb76d..6a72863 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1 +1,43 @@ -# CaZaIt-Android \ No newline at end of file +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 +```