Skip to content
This repository has been archived by the owner on Aug 13, 2023. It is now read-only.

Add github pages publishing script #143

Merged
merged 20 commits into from
Dec 11, 2018
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Psammead - News React Component Library

[![Storybook](https://github.com/storybooks/press/blob/master/badges/storybook.svg)](http://bbc-news.github.io/psammead)

# Getting Started

### Clone this repositry
Expand All @@ -16,12 +18,23 @@ cd psammead && npm install

NB, this automatically runs `npm run install:packages` in a postinstall step for you.

### Run Storybook
## Storybook

### Run Locally
```
npm run storybook
```

### Deploying

The Psammead Storybook is hosted on GitHub pages at http://bbc-news.github.io/psammead. It is currently deployed via a local script that builds Storybook to the `gh-pages` git branch which is used by GitHub pages.

```
rpm run deploy-storybook
```

NB, this automatically pushes to the 'gh-pages' branch, which deploys to the live GitHub pages site. Please only run this script on the `latest` branch.

ChrisBAshton marked this conversation as resolved.
Show resolved Hide resolved
### Build Packages/Components

```
Expand Down
Loading