diff --git a/README.md b/README.md index 8e7f523..4b3c3e8 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,13 @@ Get branch information without the `/ref/*` prefix ## Outputs -| Output | type | Example | Description | -|:--------------------:|:-----------:|:---------------------------:|:-----------------------------------------------------------:| -| current_branch | `string` | `main` *OR* `feature/test` | Always returns a valid branch name for a triggered workflow run. | -| base_ref_branch | `string` | `main` | The target branch of a pull request | -| head_ref_branch | `string` | `feature/test` | The source branch of a pull request | -| ref_branch | `string` | `1/merge` *OR* `main` | The branch that triggered the workflow run | +| Output | type | Example | Description | +|:--------------------:|:------------:|:---------------------------:|:-----------------------------------------------------------------:| +| is_default | `boolean` | `true` *OR* `false` | Detects wheter the action is running on a default branch | +| current_branch | `string` | `main` *OR* `feature/test` | Always returns a valid branch name for a triggered workflow run. | +| base_ref_branch | `string` | `main` | The target branch of a pull request | +| head_ref_branch | `string` | `feature/test` | The source branch of a pull request | +| ref_branch | `string` | `1/merge` *OR* `main` | The branch that triggered the workflow run | ## Usage