Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
inyeong-kang authored Oct 18, 2023
1 parent ae4ed95 commit 8b09cc1
Showing 1 changed file with 14 additions and 6 deletions.
20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
# VoTogether Design System

<p align="center"><img src='./src/assets/votogether_logo.png' width='100px' height='100px' ></p>
<p align="center"><img src='https://github.com/VoTogether-Design-System/design-system/assets/81199414/7f260b72-5588-41aa-9200-a493e8aa89c3' width='110px' height='110px' ></p>

> 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
```

## 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';
Expand All @@ -30,7 +30,7 @@ import { VDSProvider } from 'votogether-design-system';
</VDSProvider>;
```

2. Import components from package.
**2. Import components from package.**

```tsx
import { RoundButton } from 'votogether-design-system';
Expand All @@ -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';
Expand Down Expand Up @@ -83,6 +83,14 @@ export default function SomeComponent() {
[npm](https://www.npmjs.com/package/votogether-design-system)

## Contributors
<table>
<tr>
<td align="center"><a href="https://github.com/inyeong-kang"><img src="https://avatars.githubusercontent.com/u/113416448?v=4" width="100px;" alt=""/><br /><sub><b>수아</b></sub></a><br /></td>
<td align="center"><a href="https://github.com/inyeong-kang"><img src="https://avatars.githubusercontent.com/u/80146176?v=4" width="100px;" alt=""/><br /><sub><b>우스</b></sub></a><br /></td>
<td align="center"><a href="https://github.com/inyeong-kang"><img src="https://avatars.githubusercontent.com/u//81199414?v=4" width="100px;" alt=""/><br /><sub><b>제로</b></sub></a><br /></td>
</tr>
</table>


## License

Expand Down

0 comments on commit 8b09cc1

Please sign in to comment.