Docs | #4 | @lcomment | 리드미 작성

CAKK-DEV · May 2, 2024 · ffc9ab5 · ffc9ab5
1 parent 66b908b
commit ffc9ab5
Showing 1 changed file with 42 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,43 @@
-# cakk-server
+# &nbsp; 케이크크 <a href="https://apps.apple.com/kr/app/%EC%BC%80%EC%9D%B4%ED%81%AC%ED%81%AC/id6449973946"><img src="https://github.com/CAKK-DEV/cakk-server/assets/56003992/36114846-3e0b-493c-9638-c02ad4b3a44e" align="left" width="100"></a>
 
-개발중
+[![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgit.luolix.top%2Fcakk-dev%2Fcakk-server&count_bg=%2328DBE6&title_bg=%232D3540&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false)](https://hits.seeyoufarm.com)
+[![codecov](https://codecov.io/gh/cakk-dev/cakk-server/graph/badge.svg?token=WMYRL0M1PU)](https://codecov.io/gh/cakk-dev/cakk-server)
+[![Github Action](https://github.com/cakk-dev/cakk-server/actions/workflows/ci.yml/badge.svg)](https://github.com/cakk-dev/cakk-server/actions)
+
+<br>
+
+## Download (준비중)
+
+- #### [App Store Download](https://apps.apple.com/kr/app/%EC%BC%80%EC%9D%B4%ED%81%AC%ED%81%AC/id6449973946)
+- #### [Play Store Download](https://play.google.com/store/apps/details?id=com.prography.cakk&pcampaignid=web_share)
+
+## Introduction
+
+![Introduction](https://github.com/CAKK-DEV/cakk-server/assets/56003992/53515b12-d198-4a67-bc29-a8c4ef02df35)
+
+## Developers
+
+|                                                                                                                                                                                                                                                 Hyunseok                                                                                                                                                                                                                                                  |                                                                                                                                                                                                                                                          Taeyong                                                                                                                                                                                                                                                           |
+|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
+| <img src="https://avatars.githubusercontent.com/u/56003992?v=4" width="100" height="100" style="border-radius: 50%;"><br/><a href="https://www.linkedin.com/in/hyunseok-ko-326b62254" target="_blank"><img src="https://img.shields.io/badge/Hyunseok Ko-%230077B5.svg?style=for-the-socail&logo=linkedin&logoColor=white"/></a><br/><a href="https://github.com/lcomment" target="_blank"><img src="https://img.shields.io/badge/lcomment-181717?style=for-the-social&logo=github&logoColor=white"/></a> | <img src="https://avatars.githubusercontent.com/u/86272688?v=4" width="100" height="100" style="border-radius: 50%;"><br/><a href="https://www.linkedin.com/in/%ED%83%9C%EC%9A%A9-%EA%B9%80-76a31228a" target="_blank"><img src="https://img.shields.io/badge/Taeyong Kim-%230077B5.svg?style=for-the-social&logo=linkedin&logoColor=white"/></a><br/><a href="https://github.com/YongsHub" target="_blank"><img src="https://img.shields.io/badge/YongsHub-181717?style=for-the-social&logo=github&logoColor=white"/></a> |   <img src="https://avatars.githubusercontent.com/u/42805428?v=4" width="100" height="100" style="border-radius: 50%;"><br/><a href="https://github.com/skmwit" target="_blank"><img src="https://img.shields.io/badge/skmwit-181717?style=for-the-social&logo=github&logoColor=white"/></a>     |
+
+
+## Trouble Shooting
+
+- #### 채워나갈 예정
+
+## Directory Structure
+
+```
+├── .github
+├── config
+│   ├── checkstyle
+│   │   ├── checkstyle-rules
+│   │   └── checkstyle-suppressions 
+│   └── formatter
+│       └── intellij-formatter
+├── cakk-api
+├── cakk-common
+├── cakk-client 
+└── cakk-domain
+```