https://github.com/simbo/generator-readme

A simple yeoman generator for my usual readme.
https://github.com/simbo/generator-readme

Last synced: 10 months ago
JSON representation

A simple yeoman generator for my usual readme.

• Host: GitHub
• URL: https://github.com/simbo/generator-readme
• Owner: simbo
• License: mit
• Created: 2018-05-27T17:14:49.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2018-05-27T20:49:50.000Z (about 8 years ago)
• Last Synced: 2025-08-08T22:26:37.764Z (11 months ago)
• Language: JavaScript
• Homepage:
• Size: 40 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
generator-readme

================

  > A simple yeoman generator for my usual `README.md`.

[![npm package version](https://img.shields.io/npm/v/@simbo/generator-readme.svg?style=flat-square)](https://www.npmjs.com/package/@simbo/generator-readme)

[![Travis CI build status](https://travis-ci.org/simbo/generator-readme.svg?branch=master)](https://travis-ci.org/simbo/generator-readme/builds)

---

- [Requirements](#requirements)

- [Installation](#installation)

- [Usage](#usage)

- [Development](#development)

- [License](#license)

---

## Requirements

This is a yeoman generator. You should have installed

[yeoman](http://yeoman.io/).

## Installation

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

You can install it using…

``` sh

# …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:

``` sh

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…

``` sh

# …using npm

npm link

# …or yarn

yarn link

```

## License

[MIT © 2018 Simon Lepel](http://simbo.mit-license.org/)