1.0.1 • Published 9 years ago
changelog-init v1.0.1
changelog-init
Creates a keepachangelog.com changelog in the current directory.
Install
$ npm i changelog-init -g
Or use it apart of a larger work flow.
CLI
$ cd project-dir
$ changelog-init
changelog-init
won't overwrite existing changelogs unless you tell it to:
$ changelog-init -F
Force overwriting existing changelog
CHANGELOG.md created at /project/CHANGELOG.md
You can specify a path as well:
$ changelog-unit /path/to/project
CHANGELOG.md created at /path/to/project/CHANGELOG.md
API
var init = require('changelog-init')
var opts = {force: false}
init('path/to/changelog', opts, function(err, path) {
// Stuff
})
init
returns and error
and a path
where the CHANGELOG.md was saved.