From 4df2253250864e7c72d84fe294838fb8114b2092 Mon Sep 17 00:00:00 2001 From: SeieunYoo <101736358+SeieunYoo@users.noreply.github.com> Date: Tue, 14 Jan 2025 00:29:16 +0900 Subject: [PATCH] Update README.md --- README.md | 50 +++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 45 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5fe14347..79ef28e8 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,54 @@ -# wow-design-system -GDSC Hongik 디자인 시스템 +# WOW Design System ![image](https://github.com/user-attachments/assets/2a43de37-0e69-4b61-a8eb-4fb3e9ec167e) +와우 디자인 시스템은 디자인에 대한 고민을 줄이고 개발에만 집중할 수 있도록 제작된 GDSC Hongik의 디자인 시스템 입니다. -## Link +![npm](https://img.shields.io/npm/v/wowds-ui) ![license](https://img.shields.io/npm/l/wowds-ui) + +--- + +## 📦 Installation + +```bash +npm install wowds-ui + +pnpm add wowds-ui + +yarn add wowds-ui +``` + +## 🛠️ Usage + + +```ts +import Button from "wowds-ui/Button"; + +function App() { + return ; +} + +export default App; +``` + +## 🤝 Contributing + +``` +1. 레포 클론 +git clone https://github.com/GDSC-Hongik/wow-design-system.git + +2. 디렉토리 이동 +cd packages/wow-ui + +3. 의존성 설치 +pnpm install +``` + +## 🌐 Links - [npm](https://www.npmjs.com/package/wowds-ui) -- [storybook](https://663657b8272769a8d18a5e3f-tmzvraoptr.chromatic.com/) +- [storybook](https://wow-design-system-wow-ui.vercel.app/?path=/docs/ui-avatar--docs) - [wow-docs](https://wow-design-system-wow-docs.vercel.app/overview) -## 기술 스택 +## 🚀 Tech Stack