@roo-ui/components/src/StarRating/README.md

# StarRating

<!-- STORY -->

## Installation

```shell
$ yarn add @roo-ui/components
```

## Example

```js
import { StarRating } from '@roo-ui/components';

export default <StarRating />;
```

## Properties

| Name         | Description              | Type                  | Default | Required? |
| :----------- | :----------------------- | :-------------------- | :------ | :-------- |
| `rating`     | from 0.5 to 5            | `string` or `number`  | -       | ✔︎        |
| `ratingType` | type of rating to render | `AAA` or `SELF_RATED` | -       | ✔︎        |
| `size`       | size of the icons        | `string` or `number`  | -       | ✔︎        |