Updated README.md

tj-actions · Dec 2, 2023 · 43f1d99 · 43f1d99
1 parent d2fdfdc
commit 43f1d99
Showing 1 changed file with 16 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -21,8 +21,8 @@ Get a branch or tag name without the `/ref/*` prefix.
 
 *   [Features](#features)
 *   [Usage](#usage)
-*   [Outputs](#outputs)
 *   [Inputs](#inputs)
+*   [Outputs](#outputs)
 *   [Events](#events)
     *   [`push*`](#push)
     *   [`pull_request*`](#pull_request)
@@ -103,9 +103,23 @@ Support this project with a :star:
 
 <!-- AUTO-DOC-INPUT:END -->
 
-
 ## Outputs
 
+<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->
+
+|                                     OUTPUT                                      |  TYPE  |                                   DESCRIPTION                                    |
+|---------------------------------------------------------------------------------|--------|----------------------------------------------------------------------------------|
+| <a name="output_base_ref_branch"></a>[base\_ref\_branch](#output_base_ref_branch) | string |          The target branch of a <br>pull request or tag e.g <br>`main`           |
+|  <a name="output_current_branch"></a>[current\_branch](#output_current_branch)   | string | The current branch name regardless <br>of event\_type e.g `main`, `feature/test`  |
+|  <a name="output_default_branch"></a>[default\_branch](#output_default_branch)   | string |               The default branch name e.g <br>`main` OR `master`                 |
+| <a name="output_head_ref_branch"></a>[head\_ref\_branch](#output_head_ref_branch) | string |           The source branch of a <br>pull request e.g `feature/test`             |
+|        <a name="output_is_default"></a>[is\_default](#output_is_default)         | string |  Returns `"true"` if the current <br>branch is the default else <br>`"false"`.   |
+|              <a name="output_is_tag"></a>[is\_tag](#output_is_tag)               | string |     Returns `"true"` if the current <br>branch is a tag else <br>`"false"`.      |
+|        <a name="output_ref_branch"></a>[ref\_branch](#output_ref_branch)         | string |      The branch that triggered the <br>workflow run. e.g `1/merge`, `main`       |
+|                   <a name="output_tag"></a>[tag](#output_tag)                   | string |       The tag that triggered the <br>workflow run. e.g `v0.0.1`, `0.0.1`         |
+
+<!-- AUTO-DOC-OUTPUT:END -->
+
 ## Events
 
 ### `push*`