diff --git a/README.md b/README.md index a7688ab..26155b6 100644 --- a/README.md +++ b/README.md @@ -1 +1,51 @@ -# charts \ No newline at end of file +# Frappé Charts +GitHub-inspired simple and modern charts with zero dependencies. + +https://frappe.github.io/charts + +![graphs](https://user-images.githubusercontent.com/5196925/32153733-4a747898-bd52-11e7-9248-15ba307d3142.gif) + +### Usage +Include it in your html: +``` + +``` + +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)