Readme Generator

A command line Node.js powered README.md generator for GitHub projects.

Table of Contents

1. Installation
2. Usage
3. Credits
4. Features
5. Contributing
6. Questions
7. License

Installation

To install, run the following command(s) in your terminal:

git clone git@github.com:willmowlam/nebulus-readme-generator.git
cd nebulus-readme-generator
npm install

Usage

node index.js then answer the questions, and copy both the README.md and LICENSE files from the /output folder to your repo.

Credits

Email RegEx validation by emailregex.com and badges by shields.io

Features

• 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.

Contributing

This project is open source! Feel free to open an Issue or submit a Pull Request.

Questions

If you have any questions, please email willmowlam.510@icloud.com or visit my GitHub profile at https://github.com/willmowlam

License

Copyright (c) 2024 Will Mowlam

Readme Generator is MIT licensed.