copilot/packages/ui-toolkit/README.md

# joyent-portal-ui-toolkit

[![Docker Repository on Quay](https://quay.io/repository/yldio/joyent-ui-toolkit/status)](https://quay.io/repository/yldio/joyent-ui-toolkit)
[![License: MPL 2.0](https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg)](https://opensource.org/licenses/MPL-2.0)
[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg)](https://github.com/RichardLitt/standard-readme)
[![demo master](https://img.shields.io/badge/demo-master-3B47CC.svg)](cp-frontend-master.svc.f4b20699-b323-4452-9091-977895896da6.eu-ams-1.triton.zone:6060)
[![demo staging](https://img.shields.io/badge/demo-staging-3B47CC.svg)](cp-frontend-staging.svc.f4b20699-b323-4452-9091-977895896da6.eu-ams-1.triton.zone:6060)

## Table of Contents

- [Install](#install)
- [Usage](#usage)
- [License](#license)

## Install

```
yarn add --dev joyent-portal-ui-toolkit
```

## Usage

```js
import { H1 } from 'joyent-portal-ui-toolkit'

export default () => (
  <H1>Hello World</H1>
);
```

## Demo

```
npm run styleguide
open http://0.0.0.0:6060
```

## License

MPL-2.0