Skip to content

Commit 1a4fa96

Browse files
committed
[BOOK-309] docs: 구체적인 내용 추가
1 parent 20c7a83 commit 1a4fa96

File tree

1 file changed

+115
-4
lines changed

1 file changed

+115
-4
lines changed

README.md

Lines changed: 115 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,130 @@
77
<img width="1024" height="500" alt="reed_graphic" src="https://github.com/user-attachments/assets/357cab12-db36-4de0-8fad-664abc5df8c8" />
88
</div>
99

10-
## 🎥 Main Features
11-
1210
## 🛠 Development Environment
11+
[![Swift](https://img.shields.io/badge/Swift-5.9-orange.svg)](https://swift.org)
12+
[![Xcode](https://img.shields.io/badge/Xcode-16.4-blue.svg)](https://developer.apple.com/xcode/)
13+
[![Tuist](https://img.shields.io/badge/Tuist-4.31.0-green.svg)](https://tuist.io)
14+
[![iOS](https://img.shields.io/badge/iOS-16.0+-black.svg)](https://www.apple.com/ios)
15+
[![SPM](https://img.shields.io/badge/SPM-compatible-brightgreen.svg)](https://swift.org/package-manager/)
16+
![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/YAPP-Github/Reed-iOS?utm_source=oss&utm_medium=github&utm_campaign=YAPP-Github%2FReed-iOS&labelColor=171717&color=FF570A&link=https%3A%2F%2Fcoderabbit.ai&label=CodeRabbit+Reviews)
17+
18+
## 🎥 Main Features
19+
<table>
20+
<tr>
21+
<td align="center">도서 검색</td>
22+
<td align="center">문장 기록</td>
23+
<td align="center">OCR</td>
24+
<td align="center">기록 조회</td>
25+
<td align="center">문장 카드</td>
26+
</tr>
27+
<tr>
28+
<td>
29+
<img src="https://github.com/user-attachments/assets/55dd0968-fd9b-4222-ba4a-2e38cd5739d6" width="240">
30+
</td>
31+
<td>
32+
<img src="https://github.com/user-attachments/assets/51e66fbb-2c14-4c65-9bc2-a87de8ed1389" width="240">
33+
</td>
34+
<td>
35+
<img src="https://github.com/user-attachments/assets/35b121ee-652d-4be0-a29a-e45a5dfcfd7f" width="240">
36+
</td>
37+
<td>
38+
<img src="https://github.com/user-attachments/assets/da166b9c-cba8-450f-9970-02601f1c284f" width="240">
39+
</td>
40+
<td>
41+
<img src="https://github.com/user-attachments/assets/b5f6b54c-3d25-44ec-be7c-595a30708331" width="240">
42+
</td>
43+
</tr>
44+
</table>
1345

1446
## ✏️ Project Design
47+
<img width="886" height="479" alt="스크린샷 2025-09-28 오후 9 11 32" src="https://github.com/user-attachments/assets/ccf557e7-3d97-4482-930a-bd00b5b3ef7a" />
1548

1649
### 📂 Foldering
50+
```markdown
51+
📚 BK Projects
52+
├── 📦 BKCore
53+
│ ├── DIContainer
54+
│ │ └── Interface
55+
│ ├── Extension
56+
│ └── Logger
57+
├── 💾 BKData
58+
│ ├── API
59+
│ ├── DTO
60+
│ │ ├── Request
61+
│ │ └── Response
62+
│ ├── Repository
63+
│ ├── Service
64+
│ └── Error
65+
├── 🎨 BKDesign
66+
│ ├── Components
67+
│ │ ├── Button
68+
│ │ ├── TextField
69+
│ │ ├── BottomSheet
70+
│ │ ├── Dialog
71+
│ │ ├── Label
72+
│ │ └── Chip
73+
│ ├── Foundation
74+
│ │ ├── ColorSystem
75+
│ │ ├── Typography
76+
│ │ └── GraphicSystem
77+
│ └── Resources
78+
│ ├── Assets
79+
│ └── Fonts
80+
├── 🏛️ BKDomain
81+
│ ├── Entity
82+
│ ├── Error
83+
│ ├── Interface
84+
│ │ ├── Repository
85+
│ │ └── UseCase
86+
│ ├── UseCase
87+
│ └── VO
88+
├── 🌐 BKNetwork
89+
│ ├── Provider
90+
│ ├── Adapter
91+
│ ├── Helper
92+
│ └── Extension
93+
├── 📂 BKStorage
94+
│ ├── Storage
95+
│ │ ├── Keychain
96+
│ │ └── UserDefaults
97+
│ └── TokenStorage
98+
├── 🖼️ BKPresentation
99+
│ ├── Common
100+
│ │ ├── Component
101+
│ │ ├── Coordinator
102+
│ │ └── Extension
103+
│ ├── MainFlow
104+
│ │ ├── Home
105+
│ │ ├── BookDetail
106+
│ │ ├── Note
107+
│ │ ├── NoteCompletion
108+
│ │ ├── NoteEdit
109+
│ │ ├── Search
110+
│ │ └── Setting
111+
│ ├── ArchiveFlow
112+
│ ├── AuthFlow
113+
│ │ ├── Login
114+
│ │ └── Terms
115+
│ ├── OnboardingFlow
116+
│ ├── TabBarFlow
117+
│ └── AppCoordinator
118+
└── 📱 Booket (Main App)
119+
├── Resources
120+
└── Sources
121+
```
17122

18123
## 🎁 Library
19124
| Name | Version | Description |
20125
|:---:|:---:|:---:|
21-
| [Then](https://github.com/devxoul/Then) | `3.0.0` | 객체를 생성하고 설정하는 코드를 하나의 블록으로 묶어 가독성을 향상시킨다. |
22-
| [SnapKit](https://github.com/SnapKit/SnapKit) | `5.7.1` | Auto Layout 제약조건을 코드로 쉽게 작성할 수 있도록 한다. |
126+
| [SnapKit](https://github.com/SnapKit/SnapKit) | `5.7.1` | Auto Layout 제약조건을 코드로 쉽게 작성 |
127+
| [Kingfisher](https://github.com/onevcat/Kingfisher) | `8.5.0` | 이미지 다운로드 및 캐싱 라이브러리 |
128+
| [Lottie](https://github.com/airbnb/lottie-ios) | `4.5.2` | 애니메이션 렌더링 라이브러리 |
129+
| [KakaoSDK](https://github.com/kakao/kakao-ios-sdk) | `2.23.0` | 카카오 소셜 로그인 |
130+
| [Pulse](https://github.com/kean/Pulse) | `5.1.4` | 네트워크 로깅 및 디버깅 도구 |
131+
| [Firebase](https://github.com/firebase/firebase-ios-sdk) | `12.1.0` | Analytics, Crashlytics, Remote Config |
132+
| [Quick](https://github.com/Quick/Quick) | `7.6.2` | BDD 스타일 테스트 프레임워크 |
133+
| [Nimble](https://github.com/Quick/Nimble) | `13.7.1` | 테스트 매처 라이브러리 |
23134

24135
## 🍎 Developers
25136
| [정지용](https://github.com/clxxrlove) | [김도연](https://github.com/doyeonk429) |

0 commit comments

Comments
 (0)