docs: tweaking read me

This commit is contained in:
D. Moonfire 2024-03-11 09:56:43 -05:00
parent 36d09c0367
commit dfcc08e78f

View file

@ -6,16 +6,16 @@ This utility does one thing only, calculate the [semantic version]() from Git co
For example, the version of "Package1" will be 1.2.4 and "Package2" will be 1.3.0 from the following commits:
- fix: fixing package1
- src/package1/file1.txt
- feat: fixing package2
- src/package2/file2.txt
- fix: sweeping change
- src/package1/file.txt
- src/package2/file.txt
- feat: current version [tagged "Package1-1.2.3", "Package2-1.2.3"]
- src/package1/file.txt
- src/package2/file.txt
- `fix: fixing package1`
- `src/package1/file1.txt`
- `feat: fixing package2`
- `src/package2/file2.txt`
- `fix: sweeping change`
- `src/package1/file.txt`
- `src/package2/file.txt`
- `feat: current version` [tagged "Package1-1.2.3", "Package2-1.2.3"]
- `src/package1/file.txt`
- `src/package2/file.txt`
In the above example, the second commit is ignored while calculating the "Package1" commits while the first one is ignored while calculating "Package2".