diff --git a/README.md b/README.md index 23d3dc3..a85e029 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,9 @@ -# docs -Codedang 프로젝트 문서 +# Codedang Docs + +스꾸딩 팀을 위한 코드당 프로젝트 문서입니다 😎 + +## 실행 방법 + +1. pnpm을 설치해주세요 (https://pnpm.io/installation) +2. `pnpm install`을 실행해주세요 +3. `pnpm dev`를 실행해주세요 diff --git a/package.json b/package.json index a41c1a2..978d135 100644 --- a/package.json +++ b/package.json @@ -1,12 +1,12 @@ { "scripts": { "test": "echo \"Error: no test specified\" && exit 1", - "docs:dev": "vitepress dev", - "docs:build": "vitepress build", - "docs:preview": "vitepress preview" + "dev": "vitepress dev", + "build": "vitepress build", + "preview": "vitepress preview" }, "devDependencies": { "vitepress": "1.0.0-rc.42" }, "type": "module" -} \ No newline at end of file +}