Files
medusa-store/packages/design-system/ui/README.md

53 lines
1.6 KiB
Markdown

<p align="center">
<a href="https://www.medusajs.com">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/59018053/229103275-b5e482bb-4601-46e6-8142-244f531cebdb.svg">
<source media="(prefers-color-scheme: light)" srcset="https://user-images.githubusercontent.com/59018053/229103726-e5b529a3-9b3f-4970-8a1f-c6af37f087bf.svg">
<img alt="Medusa logo" src="https://user-images.githubusercontent.com/59018053/229103726-e5b529a3-9b3f-4970-8a1f-c6af37f087bf.svg">
</picture>
</a>
</p>
<h1 align="center">
Medusa UI
</h1>
<h4 align="center">
<a href="https://docs.medusajs.com/ui">Documentation</a> |
<a href="https://www.medusajs.com">Website</a>
</h4>
<p align="center">
Medusa's admin component library.
</p>
<p align="center">
<a href="https://github.com/medusajs/medusa/blob/develop/LICENSE">
<img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="Medusa is released under the MIT license." />
</a>
<a href="https://discord.gg/xpCwq3Kfn8">
<img src="https://img.shields.io/badge/chat-on%20discord-7289DA.svg" alt="Discord Chat" />
</a>
<a href="https://twitter.com/intent/follow?screen_name=medusajs">
<img src="https://img.shields.io/twitter/follow/medusajs.svg?label=Follow%20@medusajs" alt="Follow @medusajs" />
</a>
</p>
## Getting Started
### Installation
```sh
yarn add @medusajs/ui
```
### Usage
```jsx
import { Button } from "@medusajs/ui"
const App = () => <Button variant="primary">Hello World</Button>
```
## Documentation
You can find the documentation for Medusa UI [on the documentation site](https://docs.medusajs.com/ui).