# react-rating-charts

This package is a React wrapper for the [rating-charts.js](https://www.npmjs.com/package/rating-charts.js?activeTab=readme) package.

You can find the project on [GitHub](https://github.com/juli-txt/react-rating-charts), [npm](https://www.npmjs.com/package/react-rating-charts?activeTab=readme) or [yarn](https://classic.yarnpkg.com/en/package/react-rating-charts).

## Usage

All charts can be imported like this:

```tsx
import { Table } from "react-rating-charts";
```

This `Table` component can be used like any other React component.

## Building

To build the project, first clone the repository.
Then you can use the `yarn build` command to create a `dist`-folder containing the build.

## Documentation

The documentation can be build and locally hosted by using the `yarn docs` command in the console.

## Testing

The whole project is tested to have 100% coverage of statements, branches, functions and lines.
If you want to test the package yourself, you can call `yarn test` in the console.