Skip to content

Commit 91f2b18

Browse files
authored
Update README.md
1 parent a6235c8 commit 91f2b18

File tree

1 file changed

+41
-22
lines changed

1 file changed

+41
-22
lines changed

README.md

Lines changed: 41 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -3,56 +3,75 @@ GKCharts is a charting plug and play library. Developed with the HTML 5 Canvas a
33
This is an open source project for every one, anyone who want to improve this charting library can contribute for this project.
44

55
### How do I install GKCharts?
6-
There are two different version of gkCharts :-
7-
1. ~~For static website using gkchart.js file.
8-
To install GKCharts you can download GkCharts library from our website http://gkchart.com download button.
9-
Then you have to add this JavaScript file to your HTML page and call our api
10-
"new GKChart({id: "stepChartComparision", data: stepChartComparision})"
11-
Examples are provided at http://gkchart.com.~~
6+
## Install
7+
8+
```bash
9+
# Yarn
10+
yarn add gk-chart
11+
12+
# NPM
13+
npm install --save gk-chart
14+
```
15+
16+
Live demo => https://ganpatkakar.github.io/gkChart
1217

13-
2. For React/Angular/Vue js NPM package
14-
To use with npm package run command => npm i gk-chart
1518

1619
### Type of charts possible and the naming conventions
17-
barChart = "bar-chart";
18-
columnChart = "column-chart";
19-
lineChart = "line-chart";
20-
stepLineChart = "step-line-chart";
21-
smoothLineChart = "smooth-line-chart";
22-
multiRandomChart = "multi-random";
23-
combinationChart = "combination-chart";
24-
pieChart = "pie-chart";
25-
doughnutChart = "doughnut-chart";
26-
meterChart = "meter-chart";
27-
stackedColumnChart = "stacked-column-chart";
28-
stackedBarChart = "stacked-bar-chart";
20+
21+
```
22+
declare const GkLineChart: (data: any) => void;
23+
declare const GkStepChart: (data: any) => void;
24+
declare const GkSmoothLineChart: (data: any) => void;
25+
declare const GkBarChart: (data: any) => void;
26+
declare const GkStackedBarChart: (data: any) => void;
27+
declare const GkColumnChart: (data: any) => void;
28+
declare const GkStackedChart: (data: any) => void;
29+
declare const GkPieChart: (data: any) => void;
30+
declare const GkDoughnutChart: (data: any) => void;
31+
declare const GkMeterChart: (data: any) => void;
32+
declare const GkCombinationChart: (data: any) => void;
33+
```
2934

3035
### How to use GkChart Library or GkChart NPM package (npm install gk-cahrt) :-
31-
GkCharts support more than 20+ combination of charts with 8 chart types.
36+
GkCharts support more than 20+ combination of charts with 11 chart types.
37+
38+
Sample charts
3239

33-
Few ScreenShots of charts output.
40+
41+
Bar Chart => https://ganpatkakar.github.io/gkChart/?path=/docs/components-barchart--docs
3442

3543
<img width="1150" alt="Screenshot 2019-08-04 at 3 01 57 PM" src="https://user-images.githubusercontent.com/13637167/62478257-45914000-b7c8-11e9-8b22-5668d62f645c.png">
3644

3745
<img width="673" alt="Screenshot 2019-08-04 at 3 08 40 PM" src="https://user-images.githubusercontent.com/13637167/62478258-45914000-b7c8-11e9-992a-398fc2927619.png">
3846

47+
Stacked Chart => https://ganpatkakar.github.io/gkChart/?path=/docs/components-stackedcolumnchart--docs
48+
3949
<img width="521" alt="Screenshot 2019-08-05 at 8 07 22 PM" src="https://user-images.githubusercontent.com/13637167/62478259-45914000-b7c8-11e9-8462-25f63003590c.png">
4050

4151
<img width="729" alt="Screenshot 2019-08-05 at 8 44 46 PM" src="https://user-images.githubusercontent.com/13637167/62478260-4629d680-b7c8-11e9-85dc-bad872723f61.png">
4252

53+
Line Chart => https://ganpatkakar.github.io/gkChart/?path=/docs/components-linechart--docs
4354

4455
<img width="738" alt="Screenshot 2019-08-05 at 9 35 29 PM" src="https://user-images.githubusercontent.com/13637167/62478413-ad478b00-b7c8-11e9-8332-fbc60e0fbd39.png">
4556

4657
<img width="738" alt="Screenshot 2019-08-05 at 9 35 29 PM" src="https://user-images.githubusercontent.com/13637167/62478450-c0f2f180-b7c8-11e9-8b90-b3fd555d2588.png">
4758

59+
60+
Smooth Line Chart => https://ganpatkakar.github.io/gkChart/?path=/docs/components-smoothlinechart--docs
61+
4862
<img width="738" alt="Screenshot 2019-08-05 at 9 35 29 PM" src="https://user-images.githubusercontent.com/13637167/62478504-e122b080-b7c8-11e9-8129-dbb0ac5a81ee.png">
4963

64+
Column Chart => https://ganpatkakar.github.io/gkChart/?path=/docs/components-columnchart--docs
5065
<img width="738" alt="Screenshot 2019-08-05 at 9 35 29 PM" src="https://user-images.githubusercontent.com/13637167/62478542-fbf52500-b7c8-11e9-88de-ada301bdb9d9.png">
5166

67+
Pie Chart => https://ganpatkakar.github.io/gkChart/?path=/docs/components-piechart--docs
5268
<img width="450" alt="Screenshot 2019-08-05 at 9 35 29 PM" src="https://user-images.githubusercontent.com/13637167/62478574-0dd6c800-b7c9-11e9-854f-0da62f34c9f9.png">
5369

70+
Doughnut chart => https://ganpatkakar.github.io/gkChart/?path=/docs/components-doughnutchart--docs
5471
<img width="450" alt="Screenshot 2019-08-05 at 9 35 29 PM" src="https://user-images.githubusercontent.com/13637167/62478645-319a0e00-b7c9-11e9-9265-4e1e054c7f40.png">
5572

73+
Meter Chart => https://ganpatkakar.github.io/gkChart/?path=/docs/components-meterchart--docs
74+
<img width="1174" alt="Screenshot 2023-12-12 at 3 41 50 PM" src="https://github.com/Ganpatkakar/gkChart/assets/13637167/29b94f12-a4e9-4fc8-bbd8-c6f7072ba736">
5675

5776

5877
### Contribution

0 commit comments

Comments
 (0)