From 6d05a89021e7859609b3048dadef63a1ecef8f49 Mon Sep 17 00:00:00 2001 From: Faris Ansari Date: Thu, 12 Dec 2024 16:39:46 +0530 Subject: [PATCH] Update README.md --- README.md | 84 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 46 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index 97fc45a..9e408ca 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,9 @@ -
- - -

Frappe Charts

-
-

-

GitHub-inspired modern, intuitive and responsive charts with zero dependencies

- - Explore Demos » - - - Edit at CodeSandbox » - - - Documentation » - -

-
+
+ +charts-logo + +# Frappe Charts +**GitHub-inspired modern, intuitive and responsive charts with zero dependencies**

@@ -23,21 +11,32 @@

-

- - - -

+ -### Contents -* [Installation](#installation) -* [Usage](#usage) -* [Contribute](https://frappe.io/charts/docs/contributing) -* [License](#license) +
-#### Installation +[Explore Demos](https://frappe.io/charts) - [Edit at CodeSandbox](https://codesandbox.io/s/frappe-charts-demo-viqud) - [Documentation](https://frappe.io/charts/docs) + +
+ +
+ +## Frappe Charts +Frappe Charts is a simple charting library with a focus on a simple API. The design is inspired by various charts you see on GitHub. + +### Motivation + +ERPNext needed a simple sales history graph for its user company master to help users track sales. While using c3.js for reports, the library didn’t align well with our product’s classic design. Existing JS libraries were either too complex or rigid in their structure and behavior. To address this, I decided to create a library for translating value pairs into relative shapes or positions, focusing on simplicity. + +### Key Features + +- **Variety of chart types**: Frappe Charts supports various chart types, including Axis Charts, Area and Trends, Bar, Line, Pie, Percentage, Mixed Axis, and Heatmap. +- **Annotations and tooltips**: Charts can be annotated with x and y markers, regions, and tooltips for enhanced data context and clarity. +- **Dynamic data handling**: Add, remove, or update individual data points in place, or refresh the entire dataset to reflect changes. +- **Customizable configurations**: Flexible options like colors, animations, and custom titles allow for a highly personalized chart experience. + +## Installation -##### Via NPM Install via [`npm`](https://www.npmjs.com/get-npm): ```sh @@ -56,7 +55,7 @@ import { Chart } from 'frappe-charts/dist/frappe-charts.esm.js' import 'frappe-charts/dist/frappe-charts.min.css' ``` -##### or include within your HTML +or include within your HTML ```html @@ -64,7 +63,7 @@ import 'frappe-charts/dist/frappe-charts.min.css' ``` -#### Usage +## Usage ```js const data = { labels: ["12am-3am", "3am-6pm", "6am-9am", "9am-12am", @@ -106,7 +105,7 @@ Or for es-modules (replace `new frappe.Chart()` with `new Chart()`): ``` -If you want to contribute: +## Contributing 1. Clone this repo. 2. `cd` into project directory @@ -114,9 +113,18 @@ If you want to contribute: 4. `npm i npm-run-all -D` (*optional --> might be required for some developers*) 5. `npm run dev` -#### License -This repository has been released under the [MIT License](LICENSE) +## Links ------------------- -Project maintained by [Frappe](https://frappe.io). -Used in [ERPNext](https://erpnext.com). Read the [blog post](https://medium.com/@pratu16x7/so-we-decided-to-create-our-own-charts-a95cb5032c97). +- [Read the blog](https://medium.com/@pratu16x7/so-we-decided-to-create-our-own-charts-a95cb5032c97) + + +
+
+
+ + + + Frappe Technologies + + +