Skip to content

Commit

Permalink
Update the readme to include automatic deployment
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanbubinski committed Jul 1, 2021
1 parent e4a1073 commit 180c51b
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,11 @@ This command generates static content into the `build` directory and can be serv

## Deployment

Pushes to `master` or pull requests into `master` automatically trigger a Github action
that builds the documentation and deploys it to `gh-pages` branch.

It shouldn't be necessary, but if you want to manually deploy code to `gh-pages` branch:

```console
GIT_USER=<Your GitHub username> DEPLOYMENT_BRANCH=gh-pages USE_SSH=true npm deploy
```

We're using GitHub pages to host this site, so make sure to set the deployment deploy to `gh-pages`, as above.

0 comments on commit 180c51b

Please sign in to comment.