docs(axis, react-spring): tweaks

Hare-Lucius · Aug 19, 2020 · ec05f4b · ec05f4b
1 parent 46d1979
commit ec05f4b
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 8 deletions.
diff --git a/packages/vx-axis/Readme.md b/packages/vx-axis/Readme.md
@@ -10,6 +10,7 @@ An axis component consists of a line with ticks, tick labels, and an axis label
 interpret your graph.
 
 You can use one of the 4 pre-made axes, or you can create your own based on the `<Axis />` element.
+Note that the `@vx/react-spring` package exports an `AnimatedAxis` variant with animated ticks.
 
 ## Installation
 

diff --git a/packages/vx-demo/src/pages/docs/axis.tsx b/packages/vx-demo/src/pages/docs/axis.tsx
@@ -1,7 +1,6 @@
 import React from 'react';
 import AxisReadme from '!!raw-loader!../../../../vx-axis/Readme.md';
 import Axis from '../../../../vx-axis/src/axis/Axis';
-import AnimatedAxis from '../../../../vx-react-spring/src/axis/AnimatedAxis';
 import AxisBottom from '../../../../vx-axis/src/axis/AxisBottom';
 import AxisLeft from '../../../../vx-axis/src/axis/AxisLeft';
 import AxisRight from '../../../../vx-axis/src/axis/AxisRight';
@@ -11,7 +10,7 @@ import AxisTile from '../../components/Gallery/AxisTile';
 import BarStackTile from '../../components/Gallery/BarStackTile';
 import ThresholdTile from '../../components/Gallery/ThresholdTile';
 
-const components = [Axis, AnimatedAxis, AxisBottom, AxisLeft, AxisRight, AxisTop];
+const components = [Axis, AxisBottom, AxisLeft, AxisRight, AxisTop];
 
 const examples = [AxisTile, BarStackTile, ThresholdTile];
 

diff --git a/packages/vx-react-spring/README.md b/packages/vx-react-spring/README.md
@@ -5,13 +5,14 @@
 </a>
 
 Although `vx` is largely unopinioned on animation, there is value in abstracting the complexity +
-boilerplate of building **animated** `vx` visualization components.
-[`react-spring`](https://www.react-spring.io/) provides performant primitives for animating react
-components and is our recommended library for making animated charts.
+boilerplate of building **animated** `vx` visualization components. This package requires
+`react-spring` as a `peerDependency` (to be compatible with any usage within your app) and exports
+all `vx` components that depend on `react-spring`.
 
-In order to minimize `react-spring` as a dependency across other `vx` packages, this package
-requires `react-spring` as a `peerDependency` (to be compatible with any usage within your app) and
-exports all `vx` components that depend on `react-spring`.
+[`react-spring`](https://www.react-spring.io/) provides performant primitives for animating react
+components and is our recommended library for making animated charts. In order to minimize
+`react-spring` as a dependency across other `vx` packages, we've consolidated components which
+depend on it here.
 
 ## Installation