diff --git a/README.md b/README.md index 071da0e5..1b592180 100644 --- a/README.md +++ b/README.md @@ -1 +1,138 @@ -### test +# Reed +> 문장과 감정을 함께 담는 독서 기록 + +
+ Download_on_the_App_Store_Badge +Google_Play_Store_badge_EN
+reed_graphic +
+ +## 🛠 Development Environment +[![Swift](https://img.shields.io/badge/Swift-5.9-orange.svg)](https://swift.org) +[![Xcode](https://img.shields.io/badge/Xcode-16.4-blue.svg)](https://developer.apple.com/xcode/) +[![Tuist](https://img.shields.io/badge/Tuist-4.31.0-green.svg)](https://tuist.io) +[![iOS](https://img.shields.io/badge/iOS-16.0+-black.svg)](https://www.apple.com/ios) +[![SPM](https://img.shields.io/badge/SPM-compatible-brightgreen.svg)](https://swift.org/package-manager/) +![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) + +## 🎥 Main Features + + + + + + + + + + + + + + + +
도서 검색문장 기록OCR기록 조회문장 카드
+ + + + + + + + + +
+ +## ✏️ Project Design +스크린샷 2025-09-28 오후 9 11 32 + +### 📂 Foldering +```markdown +📚 BK Projects +├── 📦 BKCore +│ ├── DIContainer +│ │ └── Interface +│ ├── Extension +│ └── Logger +├── 💾 BKData +│ ├── API +│ ├── DTO +│ │ ├── Request +│ │ └── Response +│ ├── Repository +│ ├── Service +│ └── Error +├── 🎨 BKDesign +│ ├── Components +│ │ ├── Button +│ │ ├── TextField +│ │ ├── BottomSheet +│ │ ├── Dialog +│ │ ├── Label +│ │ └── Chip +│ ├── Foundation +│ │ ├── ColorSystem +│ │ ├── Typography +│ │ └── GraphicSystem +│ └── Resources +│ ├── Assets +│ └── Fonts +├── 🏛️ BKDomain +│ ├── Entity +│ ├── Error +│ ├── Interface +│ │ ├── Repository +│ │ └── UseCase +│ ├── UseCase +│ └── VO +├── 🌐 BKNetwork +│ ├── Provider +│ ├── Adapter +│ ├── Helper +│ └── Extension +├── 📂 BKStorage +│ ├── Storage +│ │ ├── Keychain +│ │ └── UserDefaults +│ └── TokenStorage +├── 🖼️ BKPresentation +│ ├── Common +│ │ ├── Component +│ │ ├── Coordinator +│ │ └── Extension +│ ├── MainFlow +│ │ ├── Home +│ │ ├── BookDetail +│ │ ├── Note +│ │ ├── NoteCompletion +│ │ ├── NoteEdit +│ │ ├── Search +│ │ └── Setting +│ ├── ArchiveFlow +│ ├── AuthFlow +│ │ ├── Login +│ │ └── Terms +│ ├── OnboardingFlow +│ ├── TabBarFlow +│ └── AppCoordinator +└── 📱 Booket (Main App) + ├── Resources + └── Sources +``` + +## 🎁 Library +| Name | Version | Description | +|:---:|:---:|:---:| +| [SnapKit](https://github.com/SnapKit/SnapKit) | `5.7.1` | Auto Layout 제약조건을 코드로 쉽게 작성 | +| [Kingfisher](https://github.com/onevcat/Kingfisher) | `8.5.0` | 이미지 다운로드 및 캐싱 라이브러리 | +| [Lottie](https://github.com/airbnb/lottie-ios) | `4.5.2` | 애니메이션 렌더링 라이브러리 | +| [KakaoSDK](https://github.com/kakao/kakao-ios-sdk) | `2.23.0` | 카카오 소셜 로그인 | +| [Pulse](https://github.com/kean/Pulse) | `5.1.4` | 네트워크 로깅 및 디버깅 도구 | +| [Firebase](https://github.com/firebase/firebase-ios-sdk) | `12.1.0` | Analytics, Crashlytics, Remote Config | +| [Quick](https://github.com/Quick/Quick) | `7.6.2` | BDD 스타일 테스트 프레임워크 | +| [Nimble](https://github.com/Quick/Nimble) | `13.7.1` | 테스트 매처 라이브러리 | + +## 🍎 Developers +| [정지용](https://github.com/clxxrlove) | [김도연](https://github.com/doyeonk429) | +|:---:|:---:| +| | |