From 8b09cc1930b2625a5b9f40a9554967f3b4acf7f0 Mon Sep 17 00:00:00 2001 From: jero_kang <81199414+inyeong-kang@users.noreply.github.com> Date: Wed, 18 Oct 2023 14:42:33 +0900 Subject: [PATCH] Update README.md --- README.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 2a8c2d7..96c306a 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,18 @@ # VoTogether Design System -
+ > VoTogether-Design-System is a comprehensive library of common components that features our implementation of [VoTogether](https://votogether.com/). ## Installation -Install the package in your project directory with: +**Install the package in your project directory with:** ``` npm i votogether-design-system ``` -If you want to install devDependencies, try the script below. +**If you want to install devDependencies, try the script below.** ``` npm i -D votogether-design-system @@ -20,7 +20,7 @@ npm i -D votogether-design-system ## Getting Started -1. Wrap your own components(ex. App) with `VDSProvider`. +**1. Wrap your own components(ex. App) with `VDSProvider`.** ```tsx import { VDSProvider } from 'votogether-design-system'; @@ -30,7 +30,7 @@ import { VDSProvider } from 'votogether-design-system'; ; ``` -2. Import components from package. +**2. Import components from package.** ```tsx import { RoundButton } from 'votogether-design-system'; @@ -45,7 +45,7 @@ export default function SomeComponent() { ## Usage Example -For example, Team VoTogether is currently using this package. +**For example, Team VoTogether is currently using this package.** ```tsx import { ResponsiveFlex } from 'votogether-design-system'; @@ -83,6 +83,14 @@ export default function SomeComponent() { [npm](https://www.npmjs.com/package/votogether-design-system) ## Contributors +수아 |
+ 우스 |
+ 제로 |
+