ReadMe-generator does exactly that.
As a Node.js powered command line application it creates a professional, and stylish README.md file based on a user's input. This input is created by a user responding to prompts generated with the Inquirer npm.
To create a README, first- clone or fork/clone this repository(see contributing section).
Install the required dependencies for this project: npm install --inquirer.
The application can be run using the command node index.js from the command line.
After running the command node index.js the user will be prompted with a series of questions.
The application then uses the responses to these prompts to generate a README using the fs module fs.writeFile().
Once the file has been created, see the newly create README.md file in your file directory. Enjoy!
Please refer to the Contributor Covenant for contribution guidelines.
No test need to be run at this time.
For any questions, comments, or feedback please feel free to reach out:
Copyright © Gintautas Stirbys, 2020. All Rights Reserved.
This Project is licensed under the Apache~2.0 license.