https://github.com/popomore/histgen

Generate history markdown from commit
https://github.com/popomore/histgen

Last synced: about 2 months ago
JSON representation

Generate history markdown from commit

• Host: GitHub
• URL: https://github.com/popomore/histgen
• Owner: popomore
• Created: 2015-01-09T23:10:45.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2015-01-10T04:10:15.000Z (about 10 years ago)
• Last Synced: 2024-10-16T05:21:10.133Z (3 months ago)
• Language: JavaScript
• Size: 117 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: HISTORY.md

Awesome Lists containing this project

README

        
# histgen

[![NPM version](https://img.shields.io/npm/v/histgen.svg?style=flat)](https://npmjs.org/package/histgen)

[![Build Status](https://img.shields.io/travis/popomore/histgen.svg?style=flat)](https://travis-ci.org/popomore/histgen)

[![Build Status](https://img.shields.io/coveralls/popomore/histgen?style=flat)](https://coveralls.io/r/popomore/histgen)

[![NPM downloads](http://img.shields.io/npm/dm/histgen.svg?style=flat)](https://npmjs.org/package/histgen)

Generate history markdown from commit

---

## Install

```

$ npm install histgen -g

```

## Usage

```

var History = require('histgen');

new History()

.target('CHANGELOG.md') // default is History.md

.cwd('/path/to/dir') // default is process.cwd()

.gen(1.0.0. function(err) {

  if (err) {

    return console.error(err.message);

  } 

});

```

## Commander

```

$ histgen 1.0.0

```

## LISENCE

Copyright (c) 2015 popomore. Licensed under the MIT license.