📝 update README.md

README.md

@@ -1,52 +1,58 @@
-# Flash Cards
+<div align="center">
+  <a href="https://github.com/padosum/flashcards">
+    <img src="src/assets/logo.svg" alt="Logo" width="80" height="80">
+  </a>
+  <h3 align="center">FlashCards</h3>
+</div>
 
-This template should help get you started developing with Vue 3 in Vite.
+## 사이트 URL
 
-## Recommended IDE Setup
+https://flash.padosum.dev/
 
-[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
+## 목적
 
-## Type Support for `.vue` Imports in TS
+- markdown 파일을 읽어서 플래시 카드를 만들고 학습하는 애플리케이션입니다.
+- 외울 필요가 있는 것들을 잘 기억해내기 위해 만들었습니다.
+  - ex) 프로그래밍 언어 문법과 개념 (도서 [프로그래머의 뇌](http://www.yes24.com/Product/Goods/105911017) 참고)
+- 장기적 기억을 위해 학습 데이터를 기록, 간격을 두고 반복하기 위해 사용합니다.
 
-TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
+### screenshots
 
-If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
+<img src= "./screenshots/cards.gif" width="300px">
+<img src= "./screenshots/chart.png" width="300px">
 
-1. Disable the built-in TypeScript Extension
-   1. Run `Extensions: Show Built-in Extensions` from VSCode's command palette
-   2. Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
-2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
+<br clear="left"/>
 
-## Customize configuration
+## 프로젝트 관리
 
-See [Vite Configuration Reference](https://vitejs.dev/config/).
+- 사용 흐름 기반으로 이슈 생성
+- 테스트 주도 개발
 
-## Project Setup
+## 사용 기술
 
-```sh
-npm install
-```
+- front-end: [TypeScript](https://www.typescriptlang.org/), [Vue.js](https://vuejs.org/), [Vuetify](https://vuetifyjs.com/en/)
+- testing: [Vitest](https://vitest.dev/), [testing-library](https://testing-library.com/)
+- deployment: [Vercel](https://vercel.com/)
+- etc: [Vite](https://vitejs.dev/), [Chartjs](https://www.chartjs.org/), [supermemo](https://github.com/Maxvien/supermemo), [markdown-it](https://github.com/markdown-it/markdown-it), [highlight.js](https://highlightjs.org/)
 
-### Compile and Hot-Reload for Development
+## 설치 및 실행
 
-```sh
-npm run dev
+```bash
+  git clone https://github.com/padosum/flashcards.git
+  cd flashcards
+  npm install
+  npm run dev
 ```
 
-### Type-Check, Compile and Minify for Production
+배포:
 
-```sh
-npm run build
+```bash
+  npm run build
 ```
 
-### Run Unit Tests with [Vitest](https://vitest.dev/)
-
-```sh
-npm run test:unit
-```
+## Acknowledgments
 
-### Lint with [ESLint](https://eslint.org/)
-
-```sh
-npm run lint
-```
+- Inspired by [flashmd](https://github.com/Steve2955/flashmd)
+- [supermemo](https://github.com/Maxvien/supermemo)
+- [Icon by Raycast](https://icon.ray.so/)
+- [Flash cards icons created by manshagraphics - Flaticon](https://www.flaticon.com/free-icons/flash-cards)