Error in the README.md

[ltspicer]

Error in the README.md. It should read: ''### WORK IN PROGRESS and not ''## WORK IN PROGRESS

[klein0r]

Please wrap your examples in code tags (to prevent markdown parsing)

[AlCalzone]

I assume this is related to https://github.com/AlCalzone/release-script/pull/159. As I explained there, I think the readme is correct as it is now. If not, please explain where it is wrong and why.

[klein0r]

@ltspicer I don't see the issue? Readme is correct

https://github.com/AlCalzone/release-script/blob/111e796532a1d6410e4e61662d98fd6ac7c01faa/README.md?plain=1#L37-L57

[ltspicer]

Under "usage" one # is too few.

... ...

Usage

In order to use this script, you need to maintain the changelog in either README.md or CHANGELOG.md, because every release must have a changelog. To let the script know which changes are new, use the placeholder:

Changelog

<.!-- Placeholder for the next version (at the beginning of the line): ## WORK IN PROGRESS -->

[klein0r]

Ah, okay that's a bit confusing:

https://github.com/AlCalzone/release-script/blob/111e796532a1d6410e4e61662d98fd6ac7c01faa/README.md?plain=1#L61-L78

[AlCalzone]

Ok essentially what I wrote in the last paragraph here: https://github.com/AlCalzone/release-script/pull/159#issuecomment-1987908935

If anything, we could add a sentence under usage to mention this again [...]

Not sure if that helps though - there will always someone who won't read that.