basic_readme
v1.0.1
Published
Create a README.md for your module with template headers of your choosing.
Downloads
2
Readme
#basic_readme
Create a README.md file with template headers of your choosing.
#Install With npm do:
npm install -g basic_readme
#Example
$ basic_readme my_new_repo -d -e -m -i -l
will create a new README.md with the following:
#my_new_repo
#Description
#Example
#Methods
#Install
#License
#Usage
basic_readme repo_name [options]
-d
Add a description header
-m
Add a methods header
-e
Add a example header
-i
Add a install header
-l
Add a license header
#License
MIT