A command line Node.js powered README.md generator for GitHub projects.
To install, run the following command(s) in your terminal:
git clone [email protected]:willmowlam/nebulus-readme-generator.git
cd nebulus-readme-generator
npm install
node index.js then answer the questions, and copy both the README.md and LICENSE files from the /output folder to your repo.
Email RegEx validation by emailregex.com and badges by shields.io
- Creates a README.md file by asking questions about your project.
- Creates a LICENSE file from three common license templates.
- Adds dynamic badges for License, Language, Issues, Pull Requests, Stars and Forks.
- Generates step-by-step installation instructions.
- Generates a features list.
This project is open source! Feel free to open an Issue or submit a Pull Request.
If you have any questions, please email [email protected] or visit my GitHub profile at https://github.com/willmowlam
Copyright (c) 2024 Will Mowlam
Readme Generator is MIT licensed.