stellalph / readme-generator

09 Node JS Challenge : Professional README Generator - a command line application that dynamically generates a professional README.md file

Professional README Generator

Description

A command-line application that generates a professional README file from the user's input using the Inquirer package. A command-line application will allow for a quick and easy generation of a project README to get started quickly. This will allow a project creator to spend more time working on finishing the project and less time creating a good README.

The sample README generated using the application before adding more comments to the README:-

• SAMPLE README.md1 - GitHub
• SAMPLE README.md2 - Local Machine

The link to the video to show the walkthrough of the user 's input to generate README file. Please click on the link VIDEO below to access the video.

• VIDEO

The repository name is README-GENERATOR and the URL of the GitHub repository is https://github.com/stellalph/README-GENERATOR.git

• URL GitHub repository

Table of Contents

• Installation
• Usage
• Contributing
• Tests
• Questions
• License

Installation

Ensure that node.js and npm are installed. The steps to use this appllication:-

1. Fork the repository
2. Run npm init
3. Run npm i inquirer
4. Run node.index.js

Usage

When the application starts, answer each prompt or leave blank and when all the questions are answered, a file named README will be generated within the local folder.

Contributing

To contribute to this application, create a pull request. Following a code review, your feature will be merged.

The steps taken to achieve this:-

• Fork the repo
• Create a feature branch
• Commit your new feature
• Push your branch (git push)
• Create a new pull request

Tests

Continous testing to ensure that all the criteria for the project has been met, that is :-

User Story

AS A developer
I WANT a README generator
SO THAT I can quickly create a professional README for a new project

Acceptance Criteria

GIVEN a command-line application that accepts user input
WHEN I am prompted for information about my application repository
THEN a high-quality, professional README.md is generated with the title of my project and sections entitled Description, Table of Contents, Installation, Usage, License, Contributing, Tests, and Questions
WHEN I enter my project title
THEN this is displayed as the title of the README
WHEN I enter 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 I choose a license for my 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 I enter my GitHub username
THEN this is added to the section of the README entitled Questions, with a link to my GitHub profile
WHEN I enter my email address
THEN this is added to the section of the README entitled Questions, with instructions on how to reach me with additional questions
WHEN I click on the links in the Table of Contents
THEN I am taken to the corresponding section of the README

Questions

Contact email: [email protected]

GitHub: stellalph

Reference: 09 The Unit Ahead Materials.

• The answer can be replaced on how to reach me on additional questions. If you do not receive an answer from me within two days, I can't answer your questions. Thank you for your understanding.

License

This project is licensed under the terms of the MIT license.

• For more information on license type and additional licensing information - https://choosealicense.com as per GitHub documentation.