Update README
This commit is contained in:
parent
4cfe821b03
commit
1eb6ccf471
52
README.md
52
README.md
@ -1 +1,51 @@
|
||||
# charts
|
||||
# Frappé Charts
|
||||
GitHub-inspired simple and modern charts with zero dependencies.
|
||||
|
||||
https://frappe.github.io/charts
|
||||
|
||||

|
||||
|
||||
### Usage
|
||||
Include it in your html:
|
||||
```
|
||||
<script src="frappe-charts.min.js"></script>
|
||||
```
|
||||
|
||||
Make a new Chart:
|
||||
```js
|
||||
let data = {
|
||||
labels: ["12am-3am", "3am-6am", "6am-9am", "9am-12pm",
|
||||
"12pm-3pm", "3pm-6pm", "6pm-9pm", "9pm-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]
|
||||
}
|
||||
]
|
||||
};
|
||||
|
||||
let 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: MIT
|
||||
|
||||
------------------
|
||||
Project maintained by [frappe](https://github.com/frappe)
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user