From b11907137de2f40890dfbd06618a96eab054f8b2 Mon Sep 17 00:00:00 2001
From: James Ives <iam@jamesiv.es>
Date: Fri, 8 Nov 2019 11:33:59 -0500
Subject: [PATCH] README Changes

---
 README.md   | 6 +++---
 src/git.ts  | 6 +++---
 src/main.ts | 1 -
 3 files changed, 6 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 219e8751..496cfd42 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,8 @@
 # GitHub Pages Deploy Action :rocket: 
 
-[![Actions Status](https://github.com/JamesIves/github-pages-deploy-action/workflows/integration/badge.svg)](https://github.com/JamesIves/github-pages-deploy-action/actions) [![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)
+[![Actions Status](https://github.com/JamesIves/github-pages-deploy-action/workflows/integration/badge.svg)](https://github.com/JamesIves/github-pages-deploy-action/actions) [![View Action](https://img.shields.io/badge/view-action-blue.svg?logo=github)](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  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`. This action is built on [Node](https://nodejs.org/en/), which means that you can call any optional build scripts your project requires prior to deploying.
+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`.
 
 ## 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` step before this workflow runs in order for the deployment to work. 
@@ -60,6 +60,6 @@ With the action correctly configured you should see the workflow trigger the dep
 
 ### Build Files
 
-This action maintains the full Git history of the deployment branch. Therefore if you're using a custom domain, or require the use of a `.nojekyll` file, you can safely commit these files directly into deployment branch without them being overridden after each deployment.
+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.png)
diff --git a/src/git.ts b/src/git.ts
index 64b68df3..095a927d 100644
--- a/src/git.ts
+++ b/src/git.ts
@@ -53,7 +53,7 @@ export async function generateBranch(): Promise<any> {
   }
 }
 
-/** Runs the neccersary steps to make the deployment.
+/** Runs the necessary steps to make the deployment.
  * @returns {Promise}
  */
 export async function deploy(): Promise<any> {
@@ -82,8 +82,8 @@ export async function deploy(): Promise<any> {
   );
 
   /*
-      Pushes all of the action.build files into the deployment directory.
-      Allows the user to specify the root if '.' is provided. */
+    Pushes all of the build files into the deployment directory.
+    Allows the user to specify the root if '.' is provided. */
   await cp(`${action.build}/.`, temporaryDeploymentDirectory, {
     recursive: true,
     force: true
diff --git a/src/main.ts b/src/main.ts
index 357a9715..852c294e 100644
--- a/src/main.ts
+++ b/src/main.ts
@@ -4,7 +4,6 @@ import { init, deploy } from "./git";
 /** Initializes and runs the action. */
 (async function() {
   try {
-    // Initializes the action.
     await init();
     await deploy();
   } catch (error) {