@mxttwoods/readme-cli v1.0.1

@mxttwoods/readme-cli

a cli that generates README.md files

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-cli

Use default values for all questions (-y):

npx @mxttwoods/readme-cli -y

Use your own ejs README template (-p):

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

Use global installation:

npm i -g @mxttwoods/readme-cli

readme-cli

Development

Install

yarn install

Build

yarn build

Test

yarn test

Author

Matthew Woods

• Website: https://matthew.codes
• Twitter: @mxttwoods
• GitHub: @mxttwoods
• LinkedIn: @matthew-t-woods

License

Copyright © 2021 Matthew Woods.

This project is MIT licensed.