# @scaleflex/ui

React UI components library by Scaleflex

---

## Installation

```shell script
npm i @scaleflex/ui # styled-components react react-dom
```

```shell script
yarn add @scaleflex/ui # styled-components react react-dom
```

> Make sure to have `react`, `react-dom` and `styled-components` installed in your package as they are included in our peer dependencies.

## Usage

Scaleflex UI includes several parts:

- [`core`](src/core/README.md)
- [`hooks`](src/hooks/README.md)
- [`theme`](src/theme/README.md)
- [`utils`](src/utils/README.md)