update action.yml

Signed-off-by: GuillaumeFalourd <guillaume.falourd@zup.com.br>

README.md

@@ -1,3 +1,79 @@
 # Push and Commit action
 
+[![Action test on Ubuntu](https://github.com/GuillaumeFalourd/git-commit-push/actions/workflows/ubuntu_action_test.yml/badge.svg)](https://github.com/GuillaumeFalourd/git-commit-push/actions/workflows/ubuntu_action_test.yml) [![Action test on MacOS](https://github.com/GuillaumeFalourd/git-commit-push/actions/workflows/macos_action_test.yml/badge.svg)](https://github.com/GuillaumeFalourd/git-commit-push/actions/workflows/macos_action_test.yml) [![Action test on Windows](https://github.com/GuillaumeFalourd/git-commit-push/actions/workflows/windows_action_test.yml/badge.svg)](https://github.com/GuillaumeFalourd/git-commit-push/actions/workflows/windows_action_test.yml)
+
 GitHub Action to commit & push changes made in workflows to upstream repository :octocat:
+
+_Note: This action is supported on all runners operating systems (`ubuntu`, `macos`, `windows`)_
+
+* * *
+
+## 📚 Usage
+
+### Requirements
+
+⚠️    The [`actions/checkout`](https://github.com/marketplace/actions/checkout) is mandatory to use this action, as it will be necessary to access the repository files.
+
+ * * *
+
+## ♻️ Scenarios
+
+### `1️⃣ Minimal`
+
+#### Commit and Push with `default` parameters
+
+```yaml
+    steps:
+      - uses: actions/checkout@v2.3.4
+      # [...] --> steps with actions or commands updating repository files
+      - uses: GuillaumeFalourd/git-commit-push@v1
+```
+
+### `2️⃣ Full`
+
+#### Commit and Push with `customized` parameters
+
+```yaml
+    steps:
+      - uses: actions/checkout@v2.3.4
+      # [...] --> steps with actions or commands updating repository files
+      - uses: GuillaumeFalourd/git-commit-push@v1
+        with:
+          email: ${{ github.actor }}@users.noreply.github.com
+          name: ${{ github.actor }}
+          commit_message: your_message
+          target_branch: target_branch_name
+          files: file1 file2 directory1 directory2/file3
+          remote_repository: https://github.com/owner/another_repository
+          access_token: ${{ github.token }}
+          force: true
+          empty: true
+          tags: true
+```
+
+* * *
+
+## ▶️ Action Inputs
+
+Field | Mandatory | Default Value | Observation
+------------ | ------------  | -------------
+**email** | NO | `${{ github.actor }}@users.noreply.github.com` | Github user email <br/> _e.g: `octocat@github.com`_
+**name** | NO | `${{ github.actor }}` | Github username <br/> _e.g: `octocat`_
+**commit_message** | NO | | The commit message
+**target_branch** | NO | `${{ github.ref }}` | The branch to push the changes back to
+**files** | NO | `.` (all) | The files to add separated by space <br/> _e.g: `file1 file2 directory1 directory2/file3`_
+**remote_repository** | NO | `origin` | The repository to push the code to
+**access_token** | NO | `${{ github.token }}` | [Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) (necessary if push to another repository).
+**force** | NO | | Whether to perform force push
+**empty** | NO | | Whether to allow empty commit
+**tags** | NO | | Whether to use --tags
+
+* * *
+
+## 🤝 Contributing
+
+☞ [Guidelines](https://github.com/GuillaumeFalourd/git-commit-push/blob/main/CONTRIBUTING.md)
+
+## 🏅 Licensed
+
+☞ This repository uses the [Apache License 2.0](https://github.com/GuillaumeFalourd/git-commit-push/blob/main/LICENSE)

action.yml

@@ -16,19 +16,19 @@ inputs:
     required: true
     default: Automatically updated using GitHub Actions
   target_branch:
-    description: The branch to push the changes back to, defaults to the current branch
+    description: The branch to push the changes back to
     required: true
     default: ${{ github.ref }}
   files:
-    description: The files to add separated by space, defaults to every file
+    description: The files to add separated by space
     required: true
     default: .
   remote_repository:
-    description: The repository to push the code to, defaults to origin (e.g. this repository)
+    description: The repository to push the code to
     required: true
     default: origin
   access_token:
-    description: The token used to push the code, not needed if you push to the same repository
+    description: The token used to push the code
     required: true
     default: ${{ github.token }}
   force:
@@ -36,11 +36,11 @@ inputs:
     required: true
     default: '0'
   empty:
-    description: 'Allow empty commit'
+    description: Whether to allow empty commit
     required: false
     default: '0'
   tags:
-    description: 'Determines if --tags is used'
+    description: Whether to use --tags
     required: false
     default: '0'