https://github.com/maxbeizer/start-a-changelog-js
Start a changelog for new/existing projects, using npx
https://github.com/maxbeizer/start-a-changelog-js
Last synced: 11 months ago
JSON representation
Start a changelog for new/existing projects, using npx
- Host: GitHub
- URL: https://github.com/maxbeizer/start-a-changelog-js
- Owner: maxbeizer
- License: mit
- Created: 2019-03-03T03:12:32.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-03-03T03:36:29.000Z (over 7 years ago)
- Last Synced: 2025-07-24T15:32:21.266Z (11 months ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/start-a-changelog
- Size: 4.88 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Start a Changelog JS
**NOTE: it looks like there's a more full-featured version of this concept at https://www.npmjs.com/package/keep-a-changelog**
An npx-able way to get a copy of the changelog from https://keepachangelog.com .
It's especially helpful when starting up a new project and you don't want to
leave your CLI.
## Installation
You _could_ install it, but you'll probably just want to:
```
$ npx start-a-changelog > CHANGELOG.md
```
To install (note this package has _no_ dependencies other than node/npm)
```
$ npm i -g start-a-changelog
```
## Benefits
1. starting a detailed changelog is _very nice_ for your users
2. You can `npx` it or install it globally (it has no dependencies)
## Credit
This of course would not be possible without the work of many people on
https://keepachangelog.com , espeically [Olivier
Lacan](https://github.com/olivierlacan)
The idea for this package was inspired directly by
[lice-js](https://www.npmjs.com/package/license), written by [Daniel
Haight](https://github.com/Daniel1of1)
Please note, I am not affiliated with either of the above projects.
## License
MIT — See LICENSE