From 743af370e76288697b8f4c94e3731a8be3ad586b Mon Sep 17 00:00:00 2001 From: Simon Elvery Date: Mon, 6 Jul 2020 16:28:54 +1000 Subject: [PATCH] Document the storybook availability and deployment --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f81f351..69516e1 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ A collection of reusable React components for use in Story Lab ... stories. -## Installation +## Usage ```bash npm install @abcnews/story-lab-component-library @@ -10,6 +10,8 @@ npm install @abcnews/story-lab-component-library This library is in its infancy and is barely documented or even useful. +You can see all available components in [the storybook](https://abcnews.github.io/story-lab-component-library/) + ## Development Get started: @@ -49,3 +51,9 @@ Releases are built and deployed using [np](https://github.com/sindresorhus/np). ``` npm run release ``` + +If you're deploying a new production release, you should also update the Storybook. The following command will freshly build and deploy it to GitHub pages. + +``` +npm run deploy-storybook +```