diff --git a/README.md b/README.md index 3b8a957..6ee1e8d 100644 --- a/README.md +++ b/README.md @@ -15,3 +15,11 @@ to your local server. ## Run tests locally `yarn test` + +## Deployment + +Deployment is done via [gh-pages](https://github.com/tschaub/gh-pages). This publishes files to a `gh-pages` branch on GitHub. + +This is done by the [deploy.yml](.github/workflows/deploy.yml) GitHub Action, which runs automatically on merges to the main branch, or can be manually called in GitHub UI on any branch. + +The latest commit SHA of the branch that is deployed will be recorded in a `meta` tag with name `ui-version` in the index.html of the deployed website. \ No newline at end of file