Merge pull request #257 from boostcamp-2020/dev

dev to release merge(12/21)

README.md

@@ -1 +1,90 @@
-# Project04-C-Whale
+# Project04-C-Whale
+
+<p align="center">
+ <img src="https://user-images.githubusercontent.com/23303023/102599910-7ece1400-4161-11eb-8cc5-a3323bc0ca0b.gif">
+</p>
+
+할고래DO는 **알림**, **북마크**를 지원하는 프로젝트 기반의 개인 **할 일 관리** 서비스입니다.
+
+**웨일 확장앱 API**를 활용한 알림과 북마크 기능으로 더욱 지능적으로 할 일 관리를 해보세요 !
+
+### 배포 주소
+
+http://halgoraedo.kro.kr
+
+[웨일 스토어에서 다운받기](https://store.whale.naver.com/detail/ajhijpmeecbneeignejgmlagajfbfhke)
+
+### 🎬 데모 영상 
+
+#### WEB
+
+<p align="center">
+<a href="https://www.youtube.com/embed/2HkyKg3PHXI"><img width="500" alt="스크린샷 2020-12-20 17 07 15" src="https://user-images.githubusercontent.com/18397630/102718854-ec2ea000-432d-11eb-90cb-334e8b033ae8.png"></a>
+</p>
+
+#### iOS
+
+<p align="center">
+<a href="https://www.youtube.com/embed/TzzpcT47xBk"><img width="500" alt="스크린샷 2020-12-20 17 07 15" src="https://user-images.githubusercontent.com/18397630/102708423-663b3680-42e6-11eb-8e7a-7f734f543fc9.png"></a>
+</p>
+<details> 
+<summary>🐳 웨일브라우저 연동</summary>
+
+
++ 웨일 브라우저 **알람 지원**
+
++ **웨일 브라우저 북마크에 추가**
+
++ **브라우징 중인 사이트를 할일로 추가**
+
++ **마우스 우클릭 메뉴를 통한 할일 추가**
+
+</details>
+
+<details> 
+<summary>📝할일 관리</summary>
+
+
++ **프로젝트/섹션에 추가**
+
++ **보드뷰 / 리스트 뷰 선택 가능**
+
++ **할일 Drag & Drop**
+
++ **하위 할일 추가**
+
++ **할일 관련 링크를 북마크로 추가**
+
++ **다크모드 지원**
+
+</details>
+
+
+## 🖥 기술 스택
+
+#### WEB
+
+<p align="center">
+ <img src="https://user-images.githubusercontent.com/59331444/102724154-ded6dd00-4350-11eb-8f36-8cd79fb41ab7.png"> 
+</p>
+
+## Documents
+- 제품 백로그 ([iOS](https://docs.google.com/spreadsheets/d/12ZqJbL0UhTdVH2FqpjqCzbunYzUg2QyLpx30rjz6T7Y/edit#gid=336470392), [WEB](https://docs.google.com/spreadsheets/d/12ZqJbL0UhTdVH2FqpjqCzbunYzUg2QyLpx30rjz6T7Y/edit#gid=0))
+- [API 명세](https://github.com/boostcamp-2020/Project04-C-Whale/wiki/API-Documents), 에러 명세
+- 기술 공유
+ - 공유 1
+ - 공유 2
+- [👉 할고래두 WIKI보러가기](https://github.com/boostcamp-2020/Project04-C-Whale/wiki)
+
+
+## 🕹 팀 소개 
+
+김성환(카일) [shkilo](https://github.com/shkilo)
+
+박진영(토니) [Zinyon](https://github.com/Zinyon)
+
+박진영(찐) [pjy0416](https://github.com/pjy0416)
+
+이상윤(커널) [SANGYOONLEE](https://github.com/SANGYOONLEE)
+
+최철웅(파인애플) [chelwoong](https://github.com/chelwoong)

client/README.md

@@ -1,6 +1,24 @@
 # client
 
-## Project setup
+## Folder Structure
+```
+├─src
+ ├───api
+ ├───assets
+ ├───components
+ ├───composables
+ ├───mixins
+ ├───plugins
+ ├───router
+ ├───store
+ ├───utils
+ │ └───whaleApi
+ ├───views
+ ├───App.vue
+ └───main.js
+```
+
+## Project Setup
 ```
 npm install
 ```
@@ -14,16 +32,3 @@ npm run serve
 ```
 npm run build
 ```
-
-### Run your unit tests
-```
-npm run test:unit
-```
-
-### Lints and fixes files
-```
-npm run lint
-```
-
-### Customize configuration
-See [Configuration Reference](https://cli.vuejs.org/config/).