Skip to content

A Node.js generator that dynamically produces a high-quality README file.

Notifications You must be signed in to change notification settings

devihall/readme-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Readme-generator- a node.js app

Description

Application that dynamically generates a professional README.md file from a user's input using the Inquirer package. This app can be used to generate a high-quality README file that includes what the app is for, how to use the app, how to install it, how to report issues, and how to make contributions.

A command-line application that accepts user input and prompts for information about an application repository. A high-quality, professional README.md is generated with the title of the project and sections entitled Description, Table of Contents, Installation, Usage, License, Contributing, Tests, and Questions The user enters a description, installation instructions, usage information, contribution guidelines, and test instructions then, this information is added to the sections of the README entitled Description, Installation, Usage, Contributing, and Tests. User is able to choose a license for my application from a list of options and that license is added to the README, entitled License that explains which license the application is covered under. Users can enter their GitHub username then this is added to the section of the README entitled Questions, with a link to the users GitHub profile.

video walk-through Link

https://watch.screencastify.com/v/k6VDjUwvHXQE9RsZTkMw

Installation

Install Dependencies

Usage

Developer use

License

Open Source

Credits

Node Package Manager, Inquirer nodejs logo

About

A Node.js generator that dynamically produces a high-quality README file.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published