Merge pull request #23 from dfantonio/improved_documentation

Improved readability
This commit is contained in:
Phil 2020-05-06 14:08:57 +02:00 committed by GitHub
commit ff1fa1824e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 8 deletions

View File

@ -25,15 +25,15 @@ Make sure you use the `actions/checkout@v2` action!
### Usage:
**tag-prefix:** Prefix that is used for the git tag (optional). Example:
```yaml
- name: 'Automated Version Bump'
uses: 'phips28/gh-action-bump-version@master'
with:
tag-prefix: ''
- name: 'Automated Version Bump'
uses: 'phips28/gh-action-bump-version@master'
with:
tag-prefix: ''
```
**PACKAGEJSON_DIR:** Param to parse the location of the desired package.json (optional). Example:
```yaml
- name: 'Automated Version Bump'
uses: 'phips28/gh-action-bump-version@master'
env:
PACKAGEJSON_DIR: 'frontend'
- name: 'Automated Version Bump'
uses: 'phips28/gh-action-bump-version@master'
env:
PACKAGEJSON_DIR: 'frontend'
```