From 139ec9a07f02bcab0d2f7ca6722d57840424a977 Mon Sep 17 00:00:00 2001 From: Juliya Smith Date: Fri, 6 Sep 2024 11:52:22 -0500 Subject: [PATCH] docs: instruct how to ghpages --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index b9f659d..3b77b3a 100644 --- a/README.md +++ b/README.md @@ -81,6 +81,9 @@ There are three GitHub events that trigger this action: ## GitHub Pages To set up this action with GitHub pages for the release-workflow to work, first create a branch named `gh-pages` and push it to GitHub. +Then, delete everything besides a simple `README.md`, the `.gitignore` file, and the `LICENSE` file. +Once that is all pushed, verify on the Pages tab that a site was made for you. +Now, on merges to main and releases, this site should be updated (if you are using the action). ## Development