joyent-portal/packages/ui-toolkit/readme.md

37 lines
684 B
Markdown
Raw Normal View History

2018-02-28 13:22:39 +02:00
# ui-toolkit
2018-02-28 00:40:51 +02:00
[![License: MPL 2.0](https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg?style=flat-square)](https://opensource.org/licenses/MPL-2.0)
[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
## Table of Contents
2017-10-19 16:36:18 +03:00
* [Install](#install)
* [Usage](#usage)
* [License](#license)
## Install
```
yarn add --dev joyent-portal-ui-toolkit
```
## Usage
```js
import React from 'react';
2017-10-12 21:15:51 +03:00
import { H1 } from 'joyent-portal-ui-toolkit';
2017-10-12 21:15:51 +03:00
export default () => <H1>Hello World</H1>;
```
## Demo
```
npm run styleguide
open http://0.0.0.0:6060
```
## License
MPL-2.0