diff --git a/.github/example.gif b/.github/example.gif
new file mode 100644
index 0000000..4cb659b
Binary files /dev/null and b/.github/example.gif differ
diff --git a/.github/logo.png b/.github/logo.png
new file mode 100644
index 0000000..d9b9943
Binary files /dev/null and b/.github/logo.png differ
diff --git a/.gitignore b/.gitignore
index 3091757..bf2538b 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,5 @@
+# cache
node_modules
-coverage
\ No newline at end of file
+
+# misc
+.DS_Store
\ No newline at end of file
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..e69de29
diff --git a/README.md b/README.md
index fb7d597..923a684 100644
--- a/README.md
+++ b/README.md
@@ -1,56 +1,84 @@
-

-
-
- GitHub-inspired simple and responsive charts with zero dependencies.
+
+
Frappé Charts
+
+
A zero-dependency GitHub-inspired modern, intuitive and responsive charting library
+
+ Explore the Demos »
+
-
-More information at the website: https://frappe.github.io/charts
-Core build: ~14kb gzipped
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-### Usage
+
+
+
+
+
-Install
-```
-npm install frappe-charts
-```
+### Table of Contents
+* [Installation](#installation)
+* [Usage](#usage)
+* [License](#license)
-Include it in your html:
+#### Installation
+* Install via [`npm`](https://www.npmjs.com/get-npm):
+ ```console
+ $ npm install frappe-charts
+ ```
+* ... or include in your HTML
```html
-
+
```
-Make a new Chart:
+### Usage
```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]
- }
- ]
-};
+const data = {
+ labels: ["12 A.M. - 3 A.M.", "3 A.M. - 6 P.M.", "6 A.M. - 9 A.M",
+ "9 A.M. - 12 A.M.", "12 P.M. - 3 P.M.", "3 P.M. - 6 P.M.",
+ "6 P.M. - 9 P.M.", "9 A.M. - 12 A.M."
+ ],
+ 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
-});
+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:
@@ -60,7 +88,8 @@ If you want to contribute:
3. `npm install`
4. `npm run dev`
-License: MIT
+#### 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)