d84f972fbe
* feat(ui-toolkit): smaller and simpler Card api fixes: #809 fixes: #777 * feat(ui-toolkit) - Make adjustments to header (#824) * feat(ui-toolkit) - Make adjustments to header * feat(ui-toolkit) - Make adjustments to header * add issue and pull request templates (#819) * feat(all) - Add issue and pull ruequest templates * Update PULL_REQUEST_TEMPLATE.md * Create COMMIT_GUIDELINES.md * Update PULL_REQUEST_TEMPLATE.md * Update PULL_REQUEST_TEMPLATE.md * Update COMMIT_GUIDELINES.md * feat(ui-toolkit): smaller and simpler Card api fixes: #809 fixes: #777
40 lines
1.1 KiB
Markdown
40 lines
1.1 KiB
Markdown
# 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)](http://styleguide-master.svc.f4b20699-b323-4452-9091-977895896da6.eu-ams-1.triton.zone:6060)
|
|
[![demo staging](https://img.shields.io/badge/demo-staging-3B47CC.svg)](http://styleguide-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 React from 'react';
|
|
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
|