From b034a5fe7c5d407f6d0ff3f9666019f618e332fc Mon Sep 17 00:00:00 2001 From: James Ives Date: Sun, 17 Mar 2019 14:37:25 -0400 Subject: [PATCH] README Update Pushing an update to the README to make the action more clear. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b693b59d..3ea3d12c 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![View Action](https://img.shields.io/badge/view-action-blue.svg)](https://github.com/marketplace/actions/deploy-to-github-pages) [![Issues](https://img.shields.io/github/issues/JamesIves/github-pages-deploy-action.svg)](https://github.com/JamesIves/github-pages-deploy-action/issues) -This [GitHub action](https://github.com/features/actions) will handle the building and deploying process of your project to [GitHub Pages](https://pages.github.com/). It can be configured to upload your production ready code into any branch you'd like, including `gh-pages` and `docs`. +This [GitHub action](https://github.com/features/actions) will handle the building and deploying process of your project to [GitHub Pages](https://pages.github.com/). It can be configured to upload your production ready code into any branch you'd like, including `gh-pages` and `docs`. The action is built on Node, which means that you can call any optional build scripts your project requires prior to deploying. ## Getting Started :airplane: You can include the action in your workflow to trigger on any event that [GitHub actions](https://github.com/features/actions) supports. If the remote branch that you wish to deploy to doesn't already exist the action will create it for you.