From 9e74ae3f235fee9d25b17aa276e3e96d6d8c4cbf Mon Sep 17 00:00:00 2001 From: peaceiris <30958501+peaceiris@users.noreply.github.com> Date: Sun, 29 Sep 2019 17:50:32 +0900 Subject: [PATCH] docs: update --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f71fb2b4d..cac76cb90 100644 --- a/README.md +++ b/README.md @@ -35,8 +35,8 @@ The above example step will deploy `./public` directory to `gh-pages` branch. - [Getting started](#getting-started) - - [(1) Add ssh deploy key](#1-add-ssh-deploy-key) - - [(2) Create `.github/workflows/gh-pages.yml`](#2-create-githubworkflowsgh-pagesyml) + - [(1) Add SSH deploy key](#1-add-ssh-deploy-key) + - [(2) Create your workflow](#2-create-your-workflow) - [⭐️ Repository type - Project](#%EF%B8%8F-repository-type---project) - [⭐️ Repository type - User and Organization](#%EF%B8%8F-repository-type---user-and-organization) - [Options](#options) @@ -63,7 +63,7 @@ The above example step will deploy `./public` directory to `gh-pages` branch. ## Getting started -### (1) Add ssh deploy key +### (1) Add SSH deploy key Generate your deploy key with the following command. @@ -87,7 +87,9 @@ Next, Go to **Repository Settings** |---|---| | ![](./images/secrets-1.jpg) | ![](./images/secrets-2.jpg) | -### (2) Create `.github/workflows/gh-pages.yml` +### (2) Create your workflow + +Add your workflow setting YAML file `.github/workflows/gh-pages.yml` and push to the default branch. #### ⭐️ Repository type - Project