From 17e25752a087520b813ada1a571b31b07a6f9e9a Mon Sep 17 00:00:00 2001 From: Joshua Seigler Date: Sun, 9 Oct 2022 23:30:26 -0400 Subject: [PATCH] update README --- README.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 98ba46e..5cb4702 100644 --- a/README.md +++ b/README.md @@ -16,10 +16,6 @@ NPM scripts (run with npm run scriptname) Run the project locally at http://localhost:1234 and watch for code changes -### `publish` - -Runs scripts `clean`, `build`, and `deploy` in order. - ### `clean` Deletes `./dist` @@ -28,6 +24,8 @@ Deletes `./dist` Populate `./dist` with a packaged build, ready for upload -### `deploy` +--- -Replace the contents of branch `gh-pages` with the contents of `./dist` +### Notes + +Includes a GitHub workflow to automatically build to GitHub Pages. The workflow may require adjusting if your primary branch isn't `main` or the repo isn't named `react-state-management`.