Skip to content

Commit 284f2f0

Browse files
committed
docs: updating stdin usage
1 parent cb26765 commit 284f2f0

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,16 @@ A tooling and language agnostic utility to calculate the next semantic version b
3434

3535

3636
## Usage
37-
Conventional Commits Next Version calculates the next semantic version based on the Conventional Commits since the prior version.
38-
The range of commits start exclusively from the commit specified by either the arguments `--from-commit-hash` or `--from-reference`, till inclusively of `HEAD`.
39-
Any commits in this range which conform to the Conventional Commits v1.0.0 specification are used to calculate the next Semantic Versioning, based upon the initial Semantic Versioning provided via the argument `--from-version`.
37+
Conventional Commits Next Version can either operate upon a range of Git commits in the repositories' history or on a commit message from standard in.
38+
To provide a commit message by standard in simple add the flag `--from-stdin` and standard in will be read.
39+
Otherwise to specify the range of commits you can add either the `--from-commit-hash <commit-hash>` or `--from-reference <reference>` arguments.
40+
The range of commits starts exclusively from the commit specified till inclusively of `HEAD`.
4041

41-
There are two modes of calculating the next semantic version, consecutive mode and batch mode.
42+
Any commits which conform to the Conventional Commits v1.0.0 specification are used to calculate the next Semantic Versioning, based upon the initial Semantic Versioning provided via the argument `--from-version <version>`.
43+
44+
The only required arguments is `--from-version <version>` and any of `--from-stdin`, `--from-commit-hash <commit-hash>` or `--from-reference <reference>` arguments.
45+
46+
While operating on a range of commits there are two modes of calculating the next semantic version, consecutive mode and batch mode.
4247

4348

4449
### Usage - Consecutive Mode

0 commit comments

Comments
 (0)