Skip to content

scottrohrig/readme-gen

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Professional README Generator


Description

Reduce the overhead when creating project repositories by using this readme generator. A Node.js-based CLI to streamline the process of making professional project README files.

demo

Table of Contents

Description

Installation

Usage

Contributing

License

Questions

Installation

git clone this repository. npm i to intall the dependencies from ./package.json, etc. inquirer

Usage

To run this Node.js CLI, navigate to the repository's root directory and execute the following command, node index.js. Follow the prompts to add your GitHub information and project details. You may view the output file located at ./dist/README.md

License

CC0 License

Contributing

Not taking pull requests at the moment.


Questions

To get in touch, see below:

About

A Node.js CLI for generating a professional README.md file.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •