JustReadMe

an app to help construct a trivial README file using a NodeJS console

App Walkthrough Link: https://drive.google.com/file/d/1dv_Y2-OLN9nQxgFMDew7FkChu4-gmHG4/view?usp=sharing
Repository Link: https://github.com/MrDawit/JustReadMe

Description

Readme files are sometimes long and tedius. Sometimes they are short and easy. Sometimes they are missing a whole lot of useful information that was just overlooked by the creater. For this reason, I have created an app that should make life easier for developers that need a general template of a README file that covers the most important parts of a README file that we sometimes forget (and go back to re-edit).

UserStory

AS A developer
I WANT a template for a README file
SO THAT I can only worry about writing the code at hand

Technologies Used:

Installation

• Download the repository or package to this app
• On your node terminal, use "npm install" or "npm i" to download Inquirer and FS

NPM I installs the following:

Usage Notes

• After installing, use command "npm start" on your node terminal to open "index.js"
• Follow the prompts in your terminal to create a new readme file with extension "md"
• A new readme file (Your_Name.md) should now exist in the root directory of our JustReadMe app!

Created By:

Shalom Dawit
LinkedIn:https://www.linkedin.com/in/shalom-dawit-a0a5a4126
GitHub:https://github.com/MrDawit
Email:Shalom.Dawit@gmail.com