Skip to content

Commit

Permalink
docs: add readme for charts package
Browse files Browse the repository at this point in the history
  • Loading branch information
JC Estibariz committed May 31, 2024
1 parent b7c97b7 commit 012fbf2
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions packages/pelagos-charts/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# @bluecateng/pelagos-charts [![GitHub license](https://img.shields.io/badge/license-ISC-blue.svg)](https://github.com/bluecatengineering/pelagos-packages/blob/master/LICENSE) [![npm version](https://img.shields.io/npm/v/@bluecateng/pelagos-charts.svg?style=flat)](https://www.npmjs.com/package/@bluecateng/pelagos-charts)

Chart components.

## Installation

```bash
npm i -S @bluecateng/pelagos-charts
```

## Setup

Add the following lines to the main less file. Use either `charts-light` or `charts-dark` depending on the selected theme.

```less
@import '~@bluecateng/pelagos-charts/less/palettes';

:root {
.charts-light();
}
```

## Storybook

For examples and documentation, please see [the Storybook site](https://storybook.dnsedge.tools/)

0 comments on commit 012fbf2

Please sign in to comment.