GitHub repository: https://github.com/kerilsen/readme-generator
Deployed link: https://kerilsen.github.io/readme-generator
This is a command-line application that dynamically generates a professional README.md file from a user's input using the inquirer package. It allows the user to quickly and easily create a README file by using a command-line application to generate one. It includes prompts to ensure the user creates all the content necessary for a professional README.
For future development, I would like to implement a recursive function to ask the user to keep entering steps for the installation section until they were finished. I also would like implement a way to upload screenshots and insert links that would convert to markdown.
Save the package to your local machine then navigate to the directory from your terminal. In your terminal window:
- npm init -y
- npm i inquirer@8.2.4
- npm start Then simply respond to the prompts until a README is generated.
A walkthrough video is provided here to demonstrate functionality: Video.
A sample generated README file is provided here.
n/a
n/a
If you have any questions about this project, please contact me at keri.l.sen@gmail.com.
My GitHub profile is at: https://github.com/kerilsen