Skip to content

Commit

Permalink
update readme and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
JesperLekland committed Feb 18, 2018
1 parent 026bb2e commit a63ed4b
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
8 changes: 4 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

### XAxis & YAxis

* Axes are now rendered with `react-native-svg` [Text](https://github.com/react-native-community/react-native-svg#text),
allowing for better alignment and more streamligned api.
* Axes are now rendered with `react-native-svg`'s [Text](https://github.com/react-native-community/react-native-svg#text),
allowing for better alignment and a more streamligned api.
* `svg` prop added to customize each `<Text>`
* `values`/`dataPoints` renamed to `data` to better reflect rest of component api (supports complex data)
* (XAxis) `xAccessor` prop added to extract correct value from `data` array
Expand All @@ -14,7 +14,7 @@

### `renderExtra` is removed
Seeing how `renderExtra` was almost always used to just call
the function that was passed in as `extras` we deciced to remove this step
the function that was passed in as `extras` we decided to remove this step
and simply call the `extra` entry as a function directly, passing in the same props as before

In order to allow for the above change each entry in `extras`
Expand Down Expand Up @@ -45,7 +45,7 @@ must now be a function that renders a component. See documentation for examples
* no longer renders "top" line, use `extras` for this (see docs for example)

### WaterfallChart
* deprecated
* deprecated - will be removed in future versions (due to low usage poor maintenance)

### `animate` default is now `false`
We figured opt-in is better than opt-out considering how poorly the animations are working at the moment
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

### version 3 now available!
Better API, greater extensibility and customisation!
A lot of breaking changes are introduced in this version but we've taken great care to make sure migrating is easy.
See [releases](https://github.com/JesperLekland/react-native-svg-charts/releases) for more information


Expand Down

0 comments on commit a63ed4b

Please sign in to comment.