/readme-generator

This application generates a README file based on criteria that user selected in CLI developed by @kianamsqt.

Primary LanguageJavaScript

README Generator

Description

This application generates a README file based on criteria that user selected in CLI developed by @kianamsqt.

  • When a you are prompted for information about the application repository then a high-quality, professional README.md is generated with:
    • The title of my project
    • Sections entitled:
      • Description
      • Table of Contents
      • Installation
      • Usage
      • License
      • Contributing
      • Tests
      • Questions
    • When a you enter the project title then it is displayed as the title of the README
    • When a you 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
    • When a you chooses a license for their application from a list of options then a badge for that license is added near the top of the README and a notice is added to the section of the README entitled License that explains which license the application is covered under
    • When a you enters their GitHub username then this is added to the section of the README entitled Questions, with a link to their GitHub profile
    • When a you enters their email address then this is added to the section of the README entitled Questions, with instructions on how to reach them with additional questions
    • When a you clicks on the links in the Table of Contents then they are taken to the corresponding section of the README

Installation

For installing all dependencies you need to run following command in project's directory:

npm install

or

npm i

Usage

The application will be invoked by using the following command:

node index.js

Contributing

You can reach the project on https://github.com/KianaMsqt/readme-generator