Skip to content

a command-line application that dynamically generates a professional README.md file from a user's input using the [Inquirer package]

License

Notifications You must be signed in to change notification settings

fdunnington/README-Generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

README generator


Github license

Description:

Motivation

This project was an execrise in learning how to use node, npm, and markdown. The app is aimed to make creating a README an easy process, using node prompts to create the structure of the README, and the prompt answers to complete the detail of the README.

Learnings

The project taught me not only about node and npm, and how they can be used to make processes more efficient, but also helped me develop a better understanding of Markdown, enabling me to create a clear and user-friendly instruction manual for my Github repos. This README was created with the generator.


Table of Contents:


Installation:

To use this app you will need to first install node and npm in your local dev environment.

Step 1: Install node.js (https://nodejs.dev/en/download/)

Step 2: Create and initialize a package.json file by running the following commands in the displayed order (inside the intended directory):

$ npm init -y
$ npm install

Step 3: Install npm's Inquirer module

$ npm install inquirer

Step 4: Install npm's Util module

$ npm install util

Usage

Enjoy it and make writing READMEs easier!

README generator screenshot

License

This project uses the Github license license.

Contributing

Contributor Covenant

We are happy for other developers to contribute to this project, and have adpoted the Contributor Covenant

Testing

To run test, run the following command:

node index.js

Questions

If you have any questions about the repo you can open an issue, or contact me directly at [email protected].

You can find more of my work at fdunnington.

Credits

https://www.markdownguide.org

About

a command-line application that dynamically generates a professional README.md file from a user's input using the [Inquirer package]

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published