/Readme-Generator

This project aims to create a command-line application that dynamically generates a professional README.md from a user's input.

Primary LanguageJavaScriptMIT LicenseMIT

README Generator

GitHub

License

MIT

Description

This project aims to create a command-line application that dynamically generates a professional README.md from a user's input.

Installation

To begin, run npm install to load required modules to your directory. Then, run node index.js to initialize the applicaiton. This will prompt you in the terminal with questions. Answer the questions and the README.md will be generated in the newReadme folder in the same parent directory as your index.js file.

Usage

Here's a video using the application and displaying the README it produces.

Contributing

None. Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Tests

Please make sure to update tests as appropriate.

Questions