diff --git a/README.md b/README.md index 5283cee..0fac183 100644 --- a/README.md +++ b/README.md @@ -67,16 +67,16 @@ Support this project with a :star: -| OUTPUT | TYPE | DESCRIPTION | -|-----------------|--------|-------------------------------------------------------------------------------------------------------------------------------| -| base\_ref\_branch | string | The target branch of a
pull request e.g main | -| current\_branch | string | Returns the value of the
current branch which is consistent
regardless of event\_type e.g main,
feature/test, v0.0.1. | -| default\_branch | string | | -| head\_ref\_branch | string | The source branch of a
pull request e.g feature/test | -| is\_default | string | Returns "true" if the current
branch is the default else
"false". | -| is\_tag | string | Returns "true" if the current
branch is a tag else
"false". | -| ref\_branch | string | The branch that triggered the
workflow run. e.g 1/merge, main
| -| tag | string | The tag that triggered the
workflow run. e.g v0.0.1, 0.0.1
| +| OUTPUT | TYPE | DESCRIPTION | +|-----------------|--------|----------------------------------------------------------------------------------------------------------------------------------| +| base\_ref\_branch | string | The target branch of a pull request
e.g `main` | +| current\_branch | string | Returns the value of the current branch
which is consistent regardless of event\_type e.g
`main`, `feature/test`, `v0.0.1`. | +| default\_branch | string | | +| head\_ref\_branch | string | The source branch of a pull request
e.g `feature/test` | +| is\_default | string | Returns `"true"` if the current branch is
the default else `"false"`. | +| is\_tag | string | Returns `"true"` if the current branch is
a tag else `"false"`. | +| ref\_branch | string | The branch that triggered the workflow run.
e.g `1/merge`, `main` | +| tag | string | The tag that triggered the workflow run.
e.g `v0.0.1`, `0.0.1` | @@ -84,9 +84,9 @@ Support this project with a :star: -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|------------------|--------|----------|---------|----------------------------------------------------------------| -| strip\_tag\_prefix | string | false | | The tag prefix to strip
e.g v0.0.1 -> (strip v)
-> 0.0.1 | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +|------------------|--------|----------|---------|---------------------------------------------------------------| +| strip\_tag\_prefix | string | false | | The tag prefix to strip e.g `v0.0.1
-> (strip v) -> 0.0.1` |