readme

January 01, 2021

A cli that generates README.md files

Installation

@mxttwoods/readme

Use global installation (optional):

npm i -g @mxttwoods/readme

then

readme

Usage

Make sure you have npx installed

(npx is shipped by default since npm 5.2.0)

Run the following command at the root of your project and answer the questions:

npx @mxttwoods/readme

Use default values for all questions (-y):

npx @mxttwoods/readme -y

Use your own ejs README template (-p):

npx @mxttwoods/readme -p path/to/my/own/template.md

License

This project is MIT licensed.


Profile picture

Written by Matthew Woods
UNCG Alumni & Software Developer