Merge pull request #85 from tj-actions/chore/update-readme

This commit is contained in:
Tonye Jack 2021-08-26 08:40:14 -04:00 committed by GitHub
commit b442db3234
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -10,13 +10,12 @@
Get branch or tag information without the `/ref/*` prefix
## Features
- Retrieve the current branch name without any prefix. (e.g. `'refs/heads/main'` -> `'main'`)
- Retrieve the current tag with an option to strip the "v" prefix (e.g. `'refs/tags/v1.0.0'` -> `'v1.0.0'` OR `'1.0.0'`)
- Detect actions triggered by non default branches
- Detect actions triggered by the default branch
* Retrieve the current branch name without any prefix. (e.g. `'refs/heads/main'` -> `'main'`)
* Retrieve the current tag with an option to strip the "v" prefix (e.g. `'refs/tags/v1.0.0'` -> `'v1.0.0'` OR `'1.0.0'`)
* Detect actions triggered by non default branches
* Detect actions triggered by the default branch
## Supported Platforms