Skip to content

Commit 36b2b7a

Browse files
authored
Fixing up the README 🚀
1 parent 81a7bf3 commit 36b2b7a

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Github Pages Deploy Action :rocket:
22

3-
This Github action will handle the building and deploying process of your project to Github pages. It can be configured to upload your production ready code into any branch you'd like, including `gh-pages` and `docs`.
3+
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`.
44

55
## Getting Started :airplane:
6-
Before you get started you must first create a fresh branch where the action will deploy the files to. You can replace `gh-pages` with whatever branch you'd like to use below. This will create a new orphaned branch which is what Github Pages require.
6+
Before you get started you must first create a fresh branch where the action will deploy the files to. You can replace `gh-pages` with whatever branch you'd like to use in the example below.
77

88
```git
99
git checkout --orphan gh-pages
@@ -14,7 +14,7 @@ git commit -m 'Initial gh-pages commit'
1414
git push origin gh-pages
1515
```
1616

17-
Once setup you can then include the action in your workflow to trigger on any built in event that Github supports.
17+
Once setup you can then include the action in your workflow to trigger on any event that [Github actions](https://github.com/features/actions) supports.
1818

1919
```
2020
action "Deploy to Github Pages" {
@@ -23,7 +23,7 @@ action "Deploy to Github Pages" {
2323
BUILD_SCRIPT = "npm install && npm run-script build"
2424
BRANCH = "gh-pages"
2525
FOLDER = "build"
26-
COMMIT_EMAIL = "github-pages-deployer@jamesives.dev"
26+
COMMIT_EMAIL = "github-pages-deployer@jives.dev"
2727
COMMIT_NAME = "Github Pages Deployer"
2828
}
2929
secrets = ["GITHUB_TOKEN"]
@@ -32,15 +32,15 @@ action "Deploy to Github Pages" {
3232

3333
## Configuration 📁
3434

35-
The `env` portion of the workflow must be configured before the action will work. Below you'll find a description of what each one does.
35+
The `env` portion of the workflow **must** be configured before the action will work. Below you'll find a description of what each one does.
3636

3737
| Key | Value Information | Required |
3838
| ------------- | ------------- | ------------- |
39-
| `BUILD_SCRIPT` | If you require a build script to compile your code prior to pushing it you can add the script here. The Docker container which powers the action runs Node which means `npm` commands are valid. If you're using a static site generator I'd suggest building the code prior to pushing it. | **No** |
39+
| `BUILD_SCRIPT` | If you require a build script to compile your code prior to pushing it you can add the script here. The Docker container which powers the action runs Node which means `npm` commands are valid. If you're using a static site generator such as Jekyll I'd suggest building the code prior to pushing it to your base branch. | **No** |
4040
| `BRANCH` | This is the branch you wish to deploy to, for example `gh-pages` or `docs`. | **Yes** |
4141
| `BASE_BRANCH` | The base branch of your repository which you'd like to checkout prior to deploying. This defaults to `master`. | **No** |
42-
| `FOLDER` | The folder in your repository that you want to deploy. If your build script compiles into a directory named `build` you'd put it in here. | **Yes** |
43-
| `COMMIT_NAME` | Used to sign the commit, this should be your name. | **No** |
44-
| `COMMIT_EMAIL` | Used to sign the commit, this should be your email. | **No** |
42+
| `FOLDER` | The folder in your repository that you want to deploy. If your build script compiles into a directory named `build` you'd put it here. | **Yes** |
43+
| `COMMIT_NAME` | Used to sign the commit, this should be your name. Defaults to `gh-pages-deploy@jives.dev` | **No** |
44+
| `COMMIT_EMAIL` | Used to sign the commit, this should be your email. Defaults to `Github Pages Deployer` | **No** |
4545

4646
![Example](screenshot.png)

0 commit comments

Comments
 (0)