Skip to content

Commit a229821

Browse files
committed
Update README.md
1 parent 4f9db8f commit a229821

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# github-release-notes
2-
Node module to publish release notes based on commits between the last two tags.
2+
Node module which generates a release from the latest tag and compiles release notes based on commit messages between the last two tags.
33

44
## Installation
55

@@ -11,7 +11,7 @@ npm install github-release-notes --save-dev
1111

1212
## Usage
1313

14-
You can run the command via the terminal (the three arguments ar all required):
14+
You can run the command via the terminal (the three arguments are all required):
1515

1616
```
1717
node github-release-notes --token=[token] --username=[username] --repo=[repo name]
@@ -25,4 +25,4 @@ There are optional arguments such as:
2525

2626
- `--draft=true` To set the release as a draft
2727
- `--prerelease=true` To set the release as a prerelease
28-
- `--prefix=` Add a prefix to the tag version `e.g. v1.0.1`
28+
- `--prefix=v` Add a prefix to the tag version `e.g. v1.0.1`

0 commit comments

Comments
 (0)