charts/README.md
2017-11-02 14:12:14 +05:30

95 lines
2.7 KiB
Markdown

<div align="center">
<img src="https://raw.githubusercontent.com/frappe/design/master/logos/frappe-charts-symbol.svg" height="128">
<h2>Frappé Charts</h2>
<p align="center">
<p>GitHub-inspired modern, intuitive and responsive charts with zero-dependency</p>
<a href="https://frappe.github.io/charts">
<b>Explore the Demos »</b>
</a>
</p>
</div>
<p align="center">
<a href="https://www.npmjs.com/package/frappe-charts">
<img src="https://img.shields.io/npm/v/frappe-charts.svg?maxAge=2592000">
</a>
<a href="https://www.npmjs.com/package/frappe-charts">
<img src="https://img.shields.io/npm/dm/frappe-charts.svg?maxAge=2592000">
</a>
<a href="https://www.npmjs.com/package/frappe-charts">
<img src="https://img.shields.io/npm/dt/frappe-charts.svg?maxAge=2592000">
</a>
<a href="http://github.com/frappe/charts/tree/master/dist/js/frappe-charts.min.js">
<img src="http://img.badgesize.io/frappe/charts/master/dist/frappe-charts.min.js.svg?compression=gzip">
</a>
<a href="https://saythanks.io/to/frappe">
<img src="https://img.shields.io/badge/Say%20Thanks-🦉-1EAEDB.svg?style=flat-square">
</a>
</p>
<p align="center">
<a href="https://frappe.github.io/charts">
<img src=".github/example.gif" height="300">
</a>
</p>
### Table of Contents
* [Installation](#installation)
* [Usage](#usage)
* [License](#license)
#### Installation
* Install via [`npm`](https://www.npmjs.com/get-npm):
```console
$ npm install frappe-charts
```
* ...or include within your HTML
```html
<script src="https://raw.githubusercontent.com/frappe/charts/master/dist/frappe-charts.min.js"></script>
```
### Usage
```js
const data = {
labels: ["12am - 3am", "3am - 6pm", "6am - 9 A.M",
"9am - 12am", "12pm - 3pm", "3pm - 6pm",
"6pm - 9pm", "9am - 12am"
],
datasets: [
{
title: "Some Data",
color: "light-blue",
values: [25, 40, 30, 35, 8, 52, 17, -4]
},
{
title: "Another Set",
color: "violet",
values: [25, 50, -10, 15, 18, 32, 27, 14]
}
]
}
const chart = new Chart({
parent: '#chart',
title: "My Awesome Chart",
data: data,
type: 'bar', // or 'line', 'scatter', 'percentage'
height: 250
})
```
If you want to contribute:
1. Clone this repo.
2. `cd` into project directory
3. `npm install`
4. `npm run dev`
#### License
This repository has been released under the [MIT License](LICENSE)
------------------
Made with ♥ by [pratu16x7](https://github.com/pratu16x7). Project maintained by [frappe](https://github.com/frappe)