@kisstar/rc-ui/README.md

UI component library built with React Hooks.

# Rc-UI

UI component library built with React Hooks.

[![CircleCI Status][circleci_image]][circleci_url] [![FOSSA Status][fossa_imge]][fossa_url] [![codecov][codecov_image]][codecov_url] [![NPM version][npm_image]][npm_url]

## Install

```bash
# use npm
npm install @kisstar/rc-ui

# or use yarn
yarn add @kisstar/rc-ui
```

## Usage

```js
// introduce components on demand
import { Button } from '@kisstar/rc-ui';

const App = () => <Button type="primary">CLICK ME</Button>;

// and import style manually
import '@kisstar/rc-ui/dist/index.css';
```

## Development scripts

```bash
# runs the app in the development mode
yarn start

# verify the code format and syntax in the project
yarn lint

# launches the test runner in the interactive watch mode
yarn test

# write a more friendly commit message
yarn commit
```

## License

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fkisstar%2Frc-ui.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fkisstar%2Frc-ui?ref=badge_large)

[circleci_image]: https://img.shields.io/circleci/build/github/kisstar/rc-ui/master
[circleci_url]: https://app.circleci.com/pipelines/github/kisstar/rc-ui
[codecov_image]: https://codecov.io/gh/kisstar/rc-ui/branch/master/graph/badge.svg
[codecov_url]: https://codecov.io/gh/kisstar/rc-ui
[fossa_imge]: https://app.fossa.com/api/projects/git%2Bgithub.com%2Fkisstar%2Frc-ui.svg?type=shield
[fossa_url]: https://app.fossa.com/projects/git%2Bgithub.com%2Fkisstar%2Frc-ui?ref=badge_shield
[npm_image]: https://img.shields.io/npm/v/@kisstar/rc-ui
[npm_url]: http://npmjs.org/package/@kisstar/rc-ui