From 76f17c630cb255081ca2aec9e9072a7c44015dcf Mon Sep 17 00:00:00 2001 From: CrazyMax Date: Wed, 6 Nov 2019 03:02:08 +0100 Subject: [PATCH] Update README --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 06b3594..af7eb41 100644 --- a/README.md +++ b/README.md @@ -64,10 +64,10 @@ Following inputs can be used as `step.with` keys |-----------------|---------|-------------------------------------------------------------------| | `repo` | String | GitHub repository where assets will be deployed (default current) | | `target_branch` | String | Git branch where assets will be deployed (default `gh-pages`) | -| `build_dir` | String | Build directory to deploy | -| `comitter_name` | String | Commit author's name | -| `comitter_email`| String | Commit author's email | -| `commit_message`| String | Commit message | +| `build_dir` | String | Build directory to deploy **required** | +| `comitter_name` | String | Commit author's name (default [GITHUB_ACTOR](https://help.github.com/en/github/automating-your-workflow-with-github-actions/using-environment-variables#default-environment-variables))| +| `comitter_email`| String | Commit author's email (default `GITHUB_ACTOR@users.noreply.github.com`)| +| `commit_message`| String | Commit message (default `Deploy to GitHub pages`) | ### environment variables