@cfxjs/react-ui/README.md

Modern and minimalist React UI library.

<p align="center" height="370">
<img align="center" height="370" src="https://user-images.githubusercontent.com/11304944/76085431-fd036480-5fec-11ea-8412-9e581425344a.png">
</p>

<p align="center">
<img alt="Codecov" src="https://img.shields.io/codecov/c/github/Conflux-Chain/react-ui?style=for-the-badge&labelColor=000000">
<img alt="CircleCI" src="https://img.shields.io/circleci/build/github/Conflux-Chain/react-ui?style=for-the-badge&labelColor=000000">
<img alt="npm (scoped)" src="https://img.shields.io/npm/v/@cfxjs/react-ui?style=for-the-badge&labelColor=000000">
</p>

> Modern and minimalist React UI library, originating from Vercel's design.

<br/>

## Quick Start

1. run `yarn add @cfxjs/react-ui` or `npm i @cfxjs/react-ui` install it.

2. import into project:

```jsx
import { CfxProvider, CssBaseline } from '@cfxjs/react-ui'

const Application = () => (
  <CfxProvider>
    <CssBaseline /> // ---> normalize styles
    <AppComponent /> // ---> Your App Component
  </CfxProvider>
)
```

<br/>

## Documentation

- [Document Site](https://conflux-react-ui.vercel.app/)
- [中文文档](https://conflux-react-ui.vercel.app/zh-cn)

<br/>

## Development

- [Contributing Guide](https://github.com/Conflux-Chain/react-ui/blob/master/.github/CONTRIBUTING.md)
- [Add issue here](https://github.com/Conflux-Chain/react-ui/issues/new)

<br/>

## LICENSE

[MIT](./LICENSE)