From 4b0ac9453b6b8c117d2d477feec9438cbadde554 Mon Sep 17 00:00:00 2001
From: Shohei Ueda <30958501+peaceiris@users.noreply.github.com>
Date: Sat, 18 Apr 2020 14:30:22 +0900
Subject: [PATCH] docs: Add publish_branch and publish_dir (#239)

---
 README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/README.md b/README.md
index 307220c..0be4000 100644
--- a/README.md
+++ b/README.md
@@ -68,6 +68,8 @@ Notes: Actually, the `GITHUB_TOKEN` works for deploying to GitHub Pages but it h
   - [⭐️ `github_token`](#%EF%B8%8F-github_token)
   - [⭐️ `deploy_key`](#%EF%B8%8F-deploy_key)
   - [⭐️ `personal_token`](#%EF%B8%8F-personal_token)
+  - [⭐️ `publish_branch`](#%EF%B8%8F-publish_branch)
+  - [⭐️ `publish_dir`](#%EF%B8%8F-publish_dir)
   - [⭐️ CNAME](#%EF%B8%8F-cname)
   - [⭐️ Enable Built-in Jekyll](#%EF%B8%8F-enable-built-in-jekyll)
   - [⭐️ Allow empty commits](#%EF%B8%8F-allow-empty-commits)
@@ -234,6 +236,30 @@ Read [Create SSH Deploy Key](#%EF%B8%8F-create-ssh-deploy-key), create your SSH
     publish_dir: ./public
 ```
 
+### ⭐️ `publish_branch`
+
+A target branch to deploy to GitHub Pages. The default is `gh-pages`.
+
+```yaml
+- name: Deploy
+  uses: peaceiris/actions-gh-pages@v3
+  with:
+    github_token: ${{ secrets.GITHUB_TOKEN }}
+    publish_branch: master  # default: gh-pages
+```
+
+### ⭐️ `publish_dir`
+
+A target directory to deploy to GitHub Pages. The default is `public`.
+
+```yaml
+- name: Deploy
+  uses: peaceiris/actions-gh-pages@v3
+  with:
+    github_token: ${{ secrets.GITHUB_TOKEN }}
+    publish_dir: ./out  # default: public
+```
+
 ### ⭐️ CNAME
 
 To add `CNAME` file, we can set the `cname` option.