This is README.md file generator for use on coding projects. It is a command line based utility that prompts the user for information about the title, description, table of contents, installation, usage, license, contributing, tests, and thier GitHub username and email for questions. User input is then used to generate each associated section of the README.md file. When a user selects a license from the list of options, then a badge is created by the top of the README.md with the selected license. The table of contents also links to the matching section so that README is quick to navigate.
- To install just clone this repo:
git clone [email protected]:hculp/readme-generator.git
- Install inquirer and email-validator with npm:
npm i inquirer
npm i email-validator
To use the this README.md generator, call node for index.js file.
node index.js
Follow the prompts till completion. Then, you'll have your generated README.md!
There is an example generated README.md in the assets folder. Also, an exmaple image here.
Here is a link to a demo video.
Contribution falls under open MIT license.
N/A
Send any questions or feedback to the following contacts:
- GitHub: https://github.com/hculp
- Email: [email protected]
Copyright (C) 2023 Houston Culpepper.
Distributed under the MIT License.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent