Skip to content

Commit

Permalink
docs: update README (mykola-digtiar#8)
Browse files Browse the repository at this point in the history
  • Loading branch information
jledentu authored Aug 25, 2022
1 parent 9e9ccde commit 3f3b1d5
Showing 1 changed file with 22 additions and 14 deletions.
36 changes: 22 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
<div align="center">
<img src="docs/assets/banner.png"/>
</div>
<div align="center" markdown="1">

# @energiency/chartjs-plugin-piechart-outlabels

**Highly customizable [Chart.js](http://www.chartjs.org/) plugin that displays labels outside the pie/doughnut chart**

Highly customizable [Chart.js](http://www.chartjs.org/) plugin that displays labels outside the pie/doughnut chart.
![Build Status](https://github.com/energiency/chartjs-plugin-piechart-outlabels/actions/workflows/build.yml/badge.svg)
[![Npm badge](https://img.shields.io/npm/v/@energiency/chartjs-plugin-piechart-outlabels.svg)](https://www.npmjs.com/package/@energiency/chartjs-plugin-piechart-outlabels)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

</div>

Requires [Chart.js](https://github.com/chartjs/Chart.js/releases) **2.7.0** or later.
Requires [Chart.js](https://github.com/chartjs/Chart.js/releases) **3.0.0** or later.

## Documentation

Expand All @@ -16,21 +22,23 @@ Requires [Chart.js](https://github.com/chartjs/Chart.js/releases) **2.7.0** or l

## Development

You first need to install node dependencies (requires [Node.js](https://nodejs.org/)):
You first need to install dependencies:

> npm install
```bash
> yarn install
```

The following commands will then be available from the repository root:

> gulp build // build dist files
> gulp build --watch // build and watch for changes
> gulp lint // perform code linting
> gulp package // create an archive with dist files and samples
```bash
> yarn build // build dist files in ./dist
> yarn build:dev // build and watch for source changes
```

## License

`chartjs-plugin-piechart-outlabels` is available under the [MIT license](LICENSE.md).
`@energiency/chartjs-plugin-piechart-outlabels` is available under the [MIT license](LICENSE.md).

## P.S.
## Credits

Highly inspirated by [chartjs-plugin-datalabels](https://github.com/chartjs/chartjs-plugin-datalabels)!
Thanks to [Mykola Digtiar](https://github.com/Neckster) who created the original library. This library is also highly inspirated by [chartjs-plugin-datalabels](https://github.com/chartjs/chartjs-plugin-datalabels)!

0 comments on commit 3f3b1d5

Please sign in to comment.