alec74 / dynamicreadme

Dynamic README

Description

• Providing a fast and easy way to generate readme files for projects
• Time saving method to allow users to stress less about a professional readme.md
• Haphazard readme's will be a thing of the past
• Easy to use and intuitive

Table of Contents

• Installation
• Usage
• Contributing
• License

Installation

From the command line, navigate to the project repository. Run the command "npm i inquirer" to install the required dependancy.

Usage

Navigate to the project "docs/" directory. Run the command "node index.js" to initialize the app. Fill out the required inputs. The new readme will be added to the docs directory after the "Success!" message is shown.

Contributing

If you would like to contribute to this project please feel free to reach out via the questions section or open a new issue or pull request on the github repo.

Test

The video below shows how to access the app from the command line and run through the prompts. At the end it shows the demoreadme file it generated.

Walkthrough Video

Questions

I can be contacted via email or my github account to answer questions related to building projects.

• Github Profile: Alec74
• [email protected]

License

Notice: This application is licensed under MIT

License-Link