Update Docs

README.md

@@ -28,10 +28,10 @@ Add the following step at the end of your job.
     # Optional glob pattern of files which should be added to the commit
     file_pattern: src/\*.js
 
-    # Optional repository path
+    # Optional local file path to the repository
     repository: .
 
-    # Optional commit user settings
+    # Optional commit user and author settings
     commit_user_name: My GitHub Actions Bot
     commit_user_email: my-github-actions-bot@example.org
     commit_author: Author <actions@gitub.com>

action.yml

@@ -7,18 +7,18 @@ inputs:
   commit_message:
     description: Commit message
     required: true
+  branch:
+    description: Git branch name, where changes should be pushed too.
+    required: true
   commit_options:
     description: Commit options (eg. --no-verify)
     required: false
-  branch:
-    description: Branch name where changes should be pushed too
-    required: true
   file_pattern:
-    description: File pattern used for "git add"
+    description: File pattern used for `git add`. For example `src/\*.js`
     required: false
     default: '.'
   repository:
-    description: Path to git repository
+    description: Local file path to the git repository. Defaults to the current directory (`.`)
     required: false
     default: '.'
   commit_user_name:
@@ -30,7 +30,7 @@ inputs:
     required: false
     default: actions@github.com
   commit_author:
-    description: Value used for the commit author
+    description: Value used for the commit author. Defaults to the username of whoever triggered this workflow run.
     required: false
     default: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>