From 6093d7fadc55615138ad240018da39acb58e37f0 Mon Sep 17 00:00:00 2001
From: Shun Suga <49981407+dionomusuko@users.noreply.github.com>
Date: Mon, 11 Apr 2022 00:57:08 +0900
Subject: [PATCH] fix: readme

---
 README.md | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 1789498..d43e649 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,9 @@
 
 gh-release-with-wf-dispatch crates github tag with gh-release
 
+Using this function with workflow dispatch, the RELEASE file can be rewritten.
+
+
 ## Usage
 1. Setting workflow dispatch 
 e.g.
@@ -14,12 +17,12 @@ on:
         required: 'true'
         default: 'RELEASE'
         type: choice
-        options:
+        options: # Set RELEASE file path
           - RELEASE
           - testdata/RELEASE
       newTag:
         description: 'new tag'
-        required: 'false'
+        required: 'false' # If you want to do PATCH version release, no input is required
       baseBranch:
         description: 'base branch e.g. master'
         require: 'true'
@@ -31,7 +34,7 @@ on:
 - name: release
   uses: dionomusko/gh-release-with-wf-dispatch@master
   with:
-    "github_token": ${{ secrets.GITHUB_TOKEN }}
+    "github_token": ${{ secrets.GITHUB_TOKEN }} # Set your GitHub personal access token (see: https://docs.github.com/ja/enterprise-cloud@latest/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)
     "owner": ${{ github.event.repository.owner.login }} 
     "repo": ${{ github.event.repository.name }}
     "releae_file_path": ${{ github.event.inputs.releaeFilePath }}