Loading repository data…
vish-opatha / repository
read-me-creator
This application generates a readme.md file based upon the information given by the user. This is extremly useful to reduce the time spent on writing a readme file from the scratch.
#async-await#filesystem#javascript#markdown#node-js#reademe
Live repository statistics
★ 0Stars
⑂ 0Forks
◯ 0Open issues
◉ 0Watchers
README preview
Professional Readme Creator
Description
This simple command line application facilitates the user to create a professional Readme file according to his/her requirement. It saves a lot of time by generating the markdown syntax automatically, which otherwise need to be written manually by the user.
Table of Contents
- Important Links
- Mock-up
- Installation
- Technical Acceptance Work Done
- Repository Quality Work Done
- Questions
Important Links
Following are the important links related to this application.
Mock-up
Following images shows the way of getting user inputs and the final README file that is created with the user inputs. Command line for user input
README file generated with inputs
Installation
Before the user starts this application, user needs to install the necessary dependencies, and for that run the following command:
npm install
Technical Acceptance Work Done
This project is based on command line and the user is prompted with various types of questions by using the inquirer package. Those details are collected and handled by using Javascript and run using Node.js. Inquirer package is used to prompt the questions to the user in order to get the user inputs. There are a number questions prompted to the user,related to the repository to generate a strong professional README file.
With regrds to the project license, according to the user's selection the suitable license badge is selected. User's email and github profiles are linked at the end of the README, so that interested parties could reach the user for any querries they might have.
Repository Quality Work Done
- Repository is named as read-me-creator.
- Tags are indented accordingly and comments are included while following the best practices for naming conventions.
- Changes were committed multiple times with messages.
Questions
If you have any questions about the repo, open an issue or directly contact me at v.opatha@gmail.com You can find my other work at vish-opatha