Merge pull request #24 from IPWright83/minorFixes

Minor fixes

.github/workflows/release.yml

@@ -0,0 +1,32 @@
+---
+name: Publish to NPM
+
+on:
+  release:
+    types: [created]
+jobs:
+  npm_publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      # Setup .npmrc file to publish to npm
+      - uses: actions/setup-node@v2
+        with:
+          node-version: "14.x"
+          registry-url: "https://registry.npmjs.org"
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+  deploy_storybook:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      # Setup .npmrc file to publish to npm
+      - uses: actions/setup-node@v2
+        with:
+          node-version: "14.x"
+          registry-url: "https://registry.npmjs.org"
+      - run: npm ci
+      - run: npm run build-storybook
+      - run: npm run deploy-storybook

README.md

@@ -16,6 +16,20 @@ It aims to provide high-level components that require minial configuration to pr
 
 `yarn add @chart-it/react-d3`
 
+# Getting Started
+
+The best way to get started is to take a look at some of the examples in this Storybook https://ipwright83.github.io/chart-it/?path=/story/introduction--page.
+
+Here is an example of a very basic Scatter chart
+
+```
+<XYChart data={[{ x: 10, y: 10 }, { x: 20, y: 20 }]}>
+    <Scatter x="x" y="y"/>
+    <YAxis fields={["y"]} />
+    <XAxis fields={["x"]} />
+</XYChart>
+```
+
 ## Run Locally
 
 Clone the project

config/jest/setupTests.js

@@ -11,3 +11,6 @@ window.crypto = {
         return nodeCrypto.randomFillSync(buffer);
     },
 };
+
+// Dump debug messages to the void
+console.debug = () => {};