From 7b12ca9aebe1ddcf25dc1c6fd793308e703b4ec7 Mon Sep 17 00:00:00 2001 From: peaceiris <30958501+peaceiris@users.noreply.github.com> Date: Mon, 24 Feb 2020 19:48:18 +0900 Subject: [PATCH] docs: update --- README.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index c9ccf70b3..1d72e44d8 100644 --- a/README.md +++ b/README.md @@ -61,9 +61,8 @@ Three tokens are supported. - [Getting started](#getting-started) - - [Create your workflow](#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) + - [⭐️ Repository type - Project](#%EF%B8%8F-repository-type---project) + - [⭐️ Repository type - User and Organization](#%EF%B8%8F-repository-type---user-and-organization) - [Options](#options) - [⭐️ `deploy_key`](#%EF%B8%8F-deploy_key) - [⭐️ `personal_token`](#%EF%B8%8F-personal_token) @@ -97,11 +96,9 @@ Three tokens are supported. ## Getting started -### Create your workflow +### ⭐️ Repository type - Project -Add your workflow setting YAML file `.github/workflows/gh-pages.yml` and push to the default branch. - -#### ⭐️ Repository type - Project +Add your workflow file `.github/workflows/gh-pages.yml` and push to the remote master branch. An example workflow for Hugo. @@ -150,7 +147,7 @@ The above example is for [Project Pages sites]. (`/` rep |---|---| | ![](./images/log3.jpg) | ![](./images/log4.jpg) | -#### ⭐️ Repository type - User and Organization +### ⭐️ Repository type - User and Organization For [User and Organization Pages sites] (`/.github.io` repository), we have to set `master` branch to `publish_branch`.