Skip to content

Commit e6a9a41

Browse files
committed
Update README
1 parent 05fa616 commit e6a9a41

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# changelog-updater
22

3-
A PHP CLI to update a CHANGELOG following the "Keep a Changelog" format with the latest release notes.
4-
5-
> ⚠️ This package/CLI is still in active development. Breaking changes might occur until v1 is tagged.
3+
A PHP CLI to update a CHANGELOG following the ["Keep a Changelog"](https://keepachangelog.com/) format with the latest release notes.
64

75
[![Latest Version on Packagist](https://img.shields.io/packagist/v/wnx/changelog-updater.svg?style=flat-square)](https://packagist.org/packages/wnx/changelog-updater)
86
[![Tests](https://github.com/stefanzweifel/php-changelog-updater/actions/workflows/run-tests.yml/badge.svg)](https://github.com/stefanzweifel/php-changelog-updater/actions/workflows/run-tests.yml)
@@ -11,6 +9,8 @@ A PHP CLI to update a CHANGELOG following the "Keep a Changelog" format with the
119
[![Total Downloads](https://img.shields.io/packagist/dt/wnx/changelog-updater.svg?style=flat-square)](https://packagist.org/packages/wnx/changelog-updater)
1210

1311

12+
Want to automate the process of updating your Changelog withs GitHub Actions? Checkout the [stefanzweifel/changelog-updater-action](https://github.com/stefanzweifel/changelog-updater-action) which does exactly that.
13+
1414
## Installation
1515

1616
You can install the changelog-updater CLI as a global composer dependency:
@@ -37,12 +37,19 @@ php changelog-updater update \
3737
--latest-version="v1.0.0" \
3838
--release-date="2021-08-07" \
3939
--path-to-changelog="CHANGELOG.md" \
40-
-- write
40+
--write
4141
```
4242

43-
Note that the CHANGELOG MUST to follow the "[Keep a Changelog](https://keepachangelog.com/en/1.0.0/)"-format. In detail, the CLI looks for a second level "Unreleased"-heading with a link. The link MUST to point to the compare view of the latest version and `HEAD`.
43+
`--release-date`, `--path-to-changelog` and `--write` are optional. Learn more about the options by running `php changelog-updater update --help`.
44+
45+
46+
### Important
47+
48+
Note that the Changelog MUST follow the "[Keep a Changelog](https://keepachangelog.com/en/1.0.0/)"-format.
49+
The CLI looks for a second level "Unreleased"-heading with a link. The link MUST point to the compare view of the latest version and `HEAD`.
4450
The CLI also looks for a second level heading with the name of the previous version. (If you release `v1.1.0` now, the previous version might be `v1.0.0`.)
45-
Here is an example Markdown file.
51+
52+
Here is an example Markdown file, that will work fine with the CLI.
4653

4754

4855
```md
@@ -62,6 +69,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
6269
- Initial Release
6370
```
6471

72+
The content between the "Unreleased"-heading the the latest version will remain untouched by the CLI.
73+
6574
### CLI Options
6675

6776
### `--release-notes`

0 commit comments

Comments
 (0)