Update README.md

This commit is contained in:
Faris Ansari 2024-12-12 16:39:46 +05:30 committed by GitHub
parent f333096012
commit 6d05a89021
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -1,21 +1,9 @@
<div align="center"> <div align="center" markdown="1">
<img src="https://github.com/frappe/design/blob/master/logos/logo-2019/frappe-charts-logo.png" height="128">
<a href="https://frappe.github.io/charts"> <img width="80" alt="charts-logo" src="https://github.com/user-attachments/assets/37b7ffaf-8354-48f2-8b9c-fa04fae0135b" />
<h2>Frappe Charts</h2>
</a> # Frappe Charts
<p align="center"> **GitHub-inspired modern, intuitive and responsive charts with zero dependencies**
<p>GitHub-inspired modern, intuitive and responsive charts with zero dependencies</p>
<a href="https://frappe.io/charts">
<b>Explore Demos » </b>
</a>
<a href="https://codesandbox.io/s/frappe-charts-demo-viqud">
<b> Edit at CodeSandbox »</b>
</a>
<a href="https://frappe.io/charts/docs">
<b>Documentation » </b>
</a>
</p>
</div>
<p align="center"> <p align="center">
<a href="https://bundlephobia.com/result?p=frappe-charts"> <a href="https://bundlephobia.com/result?p=frappe-charts">
@ -23,21 +11,32 @@
</a> </a>
</p> </p>
<p align="center"> <img src=".github/example.gif">
<a href="https://frappe.github.io/charts">
<img src=".github/example.gif">
</a>
</p>
### Contents <div>
* [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)
</div>
</div>
## 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 didnt align well with our products 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): Install via [`npm`](https://www.npmjs.com/get-npm):
```sh ```sh
@ -56,7 +55,7 @@ import { Chart } from 'frappe-charts/dist/frappe-charts.esm.js'
import 'frappe-charts/dist/frappe-charts.min.css' import 'frappe-charts/dist/frappe-charts.min.css'
``` ```
##### or include within your HTML or include within your HTML
```html ```html
<script src="https://cdn.jsdelivr.net/npm/frappe-charts@1.6.1/dist/frappe-charts.min.umd.js"></script> <script src="https://cdn.jsdelivr.net/npm/frappe-charts@1.6.1/dist/frappe-charts.min.umd.js"></script>
@ -64,7 +63,7 @@ import 'frappe-charts/dist/frappe-charts.min.css'
<script src="https://unpkg.com/frappe-charts@1.6.1/dist/frappe-charts.min.umd.js"></script> <script src="https://unpkg.com/frappe-charts@1.6.1/dist/frappe-charts.min.umd.js"></script>
``` ```
#### Usage ## Usage
```js ```js
const data = { const data = {
labels: ["12am-3am", "3am-6pm", "6am-9am", "9am-12am", 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. 1. Clone this repo.
2. `cd` into project directory 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*) 4. `npm i npm-run-all -D` (*optional --> might be required for some developers*)
5. `npm run dev` 5. `npm run dev`
#### License ## Links
This repository has been released under the [MIT License](LICENSE)
------------------ - [Read the blog](https://medium.com/@pratu16x7/so-we-decided-to-create-our-own-charts-a95cb5032c97)
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).
<br>
<br>
<div align="center">
<a href="https://frappe.io" target="_blank">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://frappe.io/files/Frappe-white.png">
<img src="https://frappe.io/files/Frappe-black.png" alt="Frappe Technologies" height="28"/>
</picture>
</a>
</div>