diff --git a/README.md b/README.md index 7830f18e..5d241cc4 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ This [GitHub action](https://github.com/features/actions) will handle the deploy 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`. +![Example Screenshot](screenshot.png) + ## Getting Started :airplane: You can include the action in your workflow to trigger on any event that [GitHub actions supports](https://help.github.com/en/articles/events-that-trigger-workflows). If the remote branch that you wish to deploy to doesn't already exist the action will create it for you. Your workflow will also need to include the `actions/checkout@v1` step before this workflow runs in order for the deployment to work. @@ -115,6 +117,4 @@ With the action correctly configured you should see the workflow trigger the dep ### Additional Build Files -This action maintains the full Git history of the deployment branch. Therefore if you're using a custom domain and require a `CNAME` file, or if you require the use of a `.nojekyll` file, you can safely commit these files directly into deployment branch without them being overridden after each deployment. - -![Example Screenshot](screenshot.png) +This action maintains the full Git history of the deployment branch. Therefore if you're using a custom domain and require a `CNAME` file, or if you require the use of a `.nojekyll` file, you can safely commit these files directly into deployment branch without them being overridden after each deployment. \ No newline at end of file diff --git a/screenshot.png b/screenshot.png index b145ed90..2f62d3d5 100644 Binary files a/screenshot.png and b/screenshot.png differ