A command-line application that dynamically generates a README.md from a user's input.
Project is created with:
- JavaScript
- Node.js
- Axios library
Describe the application's functionality:
The application will be invoked with the following command:
node index
Running node index will execute a series of questions that when completed, will be inserted into the README file. Questions include Github username, repository name, installation instructions, tech/frameworks used, usage description and more, and are contained in the questionsGit object.
The generateMarkdown.js file in the utils folder contains the string which integrates the user responses and generates the README file. The README file that is generated is called README_template.md
Images that demonstrate the application's functionality:
This project is licensed under the MIT license.
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
-
Option 1:🍴 Fork this repo!
-
Option 2: 👯 Clone this repo to your local machine using https://github.com/funksoup/readme-generator.git
- HACK AWAY! 🔨🔨🔨
- 🔃 Create a new pull request using https://github.com/funksoup/readme-generator/compare