1.1.1 • Published 5 years ago
readme-releases v1.1.1
Latest Release: v1.1.1, Latest Major Release: v1.0.0, All Releases
README-RELEASES
Maintain the latest release, latest major release and all releases GitHub links in the README.md.
Installation
npm install --save-dev readme-releases
- Add the line to the
README.md
:
Latest Release: ..., Latest Major Release: ..., [All Releases](...)
- Add the
version
hook to thepackage.json
:
{
"scripts": {
"version": "npx readme-releases && git add README.md"
}
}
Usage
Everytime you
npm version
the links in theREADME.md
will be updatedUse
git push --follow-tags
to push the changes for the new version together with the created git tagOpen the link of the latest release (macOS:
cmd
+double-click
on the link in the console output) and add a description to it
Contact
Found a bug or missing a feature? -> Create a new Issue
Having questions, want to give feedback or talk to me? -> E-Mail me readme-releases@sharaal.de