Skip to content

Commit 514c863

Browse files
authored
Merge pull request #81 from AkYML/document-update
update readme file
2 parents b22f3a6 + df3f9c6 commit 514c863

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

README.md

+17-3
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ YCharts is a light and extensible chart library for Jetpack Compose system. It c
77

88
## Adding YCharts to your project:
99

10-
You can add automatically the library via Maven:
10+
You can add the library via Maven:
1111

1212
Gradle:
1313
```groovy
14-
implementation 'co.yml:ycharts:1.0.0'
14+
implementation 'co.yml:ycharts:2.0.0'
1515
```
1616

1717
## Modules
@@ -43,13 +43,15 @@ Let's see how we can use the chart components and style them with available cust
4343
```
4444
val xAxisData = AxisData.Builder()
4545
.axisStepSize(100.dp)
46+
.backgroundColor(Color.Blue)
4647
.steps(pointsData.size - 1)
4748
.labelData { i -> i.toString() }
4849
.labelAndAxisLinePadding(15.dp)
4950
.build()
5051
5152
val yAxisData = AxisData.Builder()
5253
.steps(steps)
54+
.backgroundColor(Color.Red)
5355
.labelAndAxisLinePadding(20.dp)
5456
.labelData { i ->
5557
val yScale = 100 / steps
@@ -73,7 +75,8 @@ Let's see how we can use the chart components and style them with available cust
7375
),
7476
xAxisData = xAxisData,
7577
yAxisData = yAxisData,
76-
gridLines = GridLines()
78+
gridLines = GridLines(),
79+
backgroundColor = Color.White
7780
)
7881
```
7982
* Finally use the _**`LineChart`**_ Component to render the line chart with the above input
@@ -349,6 +352,17 @@ Let's see how we can use the chart components and style them with available cust
349352
To interact with your device with touch and spoken feedback, you can turn on the TalkBack screen reader. TalkBack describes the graphs/charts when tapped on the graph container.
350353
Compose views by deafult supports accessibility services, but for views drawn using canvas has no straight forward approach as of now, hence all our graph components supports an accessibility popup out of the box that will be shown over the graph with tapped on the container, with all the values described in an order to support accessibility services. User will be able to scroll the popup and find all the points, bars, slices or combined values in a descriptive manner, where user can tap and talkback would read it out loud.
351354
355+
## KMM Support.
356+
* For the ongoing effort to provide multiplatform solution, Ycharts now being written in Compose Multiplatform, adopting KMM has been a game-changer, we hope to achieve good results in this effort with community contribution.
357+
Currently KMM compatible code can be found at _**`kmm-main`**_ branch
358+
359+
360+
## Changes in version 2.0
361+
* Fix for multiple line graph/chart has been added, now it can be used to plot multiple line graphs/line charts on a single canvas or a single line with multiple colors.
362+
* Background color for Pie chart/Donut chart now can be set via _**`backgroundColor`**_ parameter through PieChartConfig model, this is done to keep the behaviour consistent with current syntax pattern.
363+
* Kotlin-library updates: _**`Kotlin version`**_ has been upgraded to '1.8.10' along with agp, compose-compiler, core-ktx, target sdk, and other compatible library updates.
364+
* Sample App has been updated to showcase more use-cases for each chart type.
365+
352366
353367
<figure>
354368
<div align = "center">

0 commit comments

Comments
 (0)