Add more README info

FormidableLabs · Oct 25, 2021 · 4e53730 · 4e53730
1 parent e5761a3
commit 4e53730
Showing 1 changed file with 28 additions and 0 deletions.
diff --git a/packages/victory-canvas/README.md b/packages/victory-canvas/README.md
@@ -2,6 +2,34 @@
 
 This is an experimental set of primitive components that can be used in place of the default Victory primitives to render data to a Canvas container rather than SVG.
 
+The current version of this package includes components for line, bar, and scatter charts.
+
+Example usage:
+
+```js
+<VictoryLine
+  groupComponent={<CanvasGroup />}
+  dataComponent={<CanvasCurve />}
+  data={data}
+/>
+```
+
+```js
+<VictoryBar
+  groupComponent={<CanvasGroup />}
+  dataComponent={<CanvasBar />}
+  data={data}
+/>
+```
+
+```js
+<VictoryScatter
+  groupComponent={<CanvasGroup />}
+  dataComponent={<CanvasPoint />}
+  data={data}
+/>
+```
+
 This package currently exports:
 
 - `CanvasGroup`