@simbo/generator-readme v0.1.0

generator-readme

A simple yeoman generator for my usual README.md.

• Requirements
• Installation
• Usage
• Development
• License

Requirements

This is a yeoman generator. You should have installed yeoman.

Installation

@simbo/generator-readme is a public user-scoped npm package.

You can install it using…

# …npm
npm install -g @simbo/generator-readme

# …or yarn
yarn global add @simbo/generator-readme

Usage

Use it like any other yeoman generator within your project root:

yo @simbo/readme

See also yo @simbo/readme --help for detailed usage information.

Development

Link from project root to use it like a globally installed package on your machine…

# …using npm
npm link

# …or yarn
yarn link

License

MIT © 2018 Simon Lepel