generates-readme v0.2.0

Generates: Readme

A Generates generator that creates a customizeable Readme file

CLI usage

1. Install generates-readme globally:

npm install -g generates-readme

2. Run generates-readme:

generates-readme

Mixin usage

1. Install generates-readme locally:

npm install --save generates-readme

2. Pass generates-readme as a mixin:

import { Generator } from 'generates'
import GeneratesReadme from 'generates-readme'

export default class GeneratesNodeModule extends Generator {
  constructor (data) {
    super(data, [GeneratesReadme])
}