From 180c51b6e482f1109a5c92ccf3efd2836704f940 Mon Sep 17 00:00:00 2001
From: Ryan Bubinski <ryanbubinski@gmail.com>
Date: Wed, 30 Jun 2021 17:46:38 -0700
Subject: [PATCH] Update the readme to include automatic deployment

---
 README.md | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 91bc70c..f617043 100644
--- a/README.md
+++ b/README.md
@@ -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.