Skip to content

Commit

Permalink
docs: README 수정
Browse files Browse the repository at this point in the history
  • Loading branch information
bh2980 committed May 19, 2024
1 parent 5293a97 commit d9b0232
Showing 1 changed file with 33 additions and 16 deletions.
49 changes: 33 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,38 +5,55 @@
chistock-ui는 chistock을 위한 디자인 시스템 라이브러리입니다.
<br/>

- [ ] 디자인 시스템과 스토리북을 통한 CDD 프론트엔드 개발
- [ ] D3.js 혹은 SVG를 이용한 데이터 시각화
- [ ] 테스트 라이브러리들을 이용한 테스트 코드 작성
- [ ] NPM 라이브러리 배포
## 설치 방법

1. 패키지 매니저를 통해 다운로드

```bash
npm install chistock-ui
yarn add chistock-ui
```

<br/>

2. 전역 style import

```ts
//index.ts
import "chistock-ui/style.css";
```

<br/>
를 목표로 삼아 개발했습니다.
<br/><br/>

## 배포
3. 원하는 컴포넌트를 가져와 사용

🚀 [NPM](https://www.npmjs.com/package/chistock-ui)
```ts
//your-component.tsx
import { Button } from 'chostock-ui'

const Component = () => {
return <div>
<Button>버튼</Button>
</div>
}
```

<br/>

## 관련 사이트
## 컴포넌트 문서

📕 Storybook - 준비 중
🗒️ [Notion](https://bh2980.notion.site/chistock-ui-4e9b7bbd072d4ca49216d812c722422d?pvs=4)
📈 [chistock으로 이동](https://github.com/bh2980/chistock)
chistock-ui Storybook - 준비 중

<br/>

## 기술 스택

<img src="https://img.shields.io/badge/vite-646CFF?style=for-the-badge&logo=vite&logoColor=white"> <img src="https://img.shields.io/badge/typescript-3178C6?style=for-the-badge&logo=typescript&logoColor=white"> <img src="https://img.shields.io/badge/react-61DAFB?style=for-the-badge&logo=react&logoColor=black">

<img src="https://img.shields.io/badge/tailwind-06B6D4?style=for-the-badge&logo=tailwindcss&logoColor=white"> <img src="https://img.shields.io/badge/tailwind variants-000000?style=for-the-badge&logo=tailwindvariants&logoColor=white">

<img src="https://img.shields.io/badge/d3-F9A03C?style=for-the-badge&logo=d3.js&logoColor=white">
<img src="https://img.shields.io/badge/tailwind-06B6D4?style=for-the-badge&logo=tailwindcss&logoColor=white"> <img src="https://img.shields.io/badge/tailwind variants-000000?style=for-the-badge&logo=tailwindvariants&logoColor=white">

<img src="https://img.shields.io/badge/storybook-FF4785?style=for-the-badge&logo=storybook&logoColor=white"> <img src="https://img.shields.io/badge/chromatic-FC521F?style=for-the-badge&logo=chromatic&logoColor=white"> <img src="https://img.shields.io/badge/jest-C21325?style=for-the-badge&logo=jest&logoColor=white"> <img src="https://img.shields.io/badge/react testing library-E33332?style=for-the-badge&logo=testinglibrary&logoColor=white">
<img src="https://img.shields.io/badge/d3-F9A03C?style=for-the-badge&logo=d3.js&logoColor=white">

<img src="https://img.shields.io/badge/storybook-FF4785?style=for-the-badge&logo=storybook&logoColor=white"> <img src="https://img.shields.io/badge/chromatic-FC521F?style=for-the-badge&logo=chromatic&logoColor=white"> <img src="https://img.shields.io/badge/jest-C21325?style=for-the-badge&logo=jest&logoColor=white"> <img src="https://img.shields.io/badge/react testing library-E33332?style=for-the-badge&logo=testinglibrary&logoColor=white">

<br/>

0 comments on commit d9b0232

Please sign in to comment.