Skip to content

Commit 729990b

Browse files
Update README.md with an example
Fixes martinbeentjes#1
1 parent 6ce3d5c commit 729990b

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
11
# npm-get-version-action
22

33
This GitHub Action retrieves the package version from the package.json file and sets the version in the `current-version` output value usable in your workflow file.
4+
5+
## Example
6+
7+
To use this action in your project, use the following:
8+
9+
```
10+
- name: get-npm-version
11+
uses: martinbeentjes/npm-get-version-action@v1
12+
```
13+
14+
The Action sets an output variable called `current-version` which can be used in a following step by using `${{ steps.get-npm-version.outputs.current-version}}``.

0 commit comments

Comments
 (0)