mdgenie
v1.0.1
Published
A CLI tool that generates beautiful README files based on user inputs
Maintainers
Readme
MDGenie
MDGenie is an interactive CLI tool that generates beautiful README.md files for your projects. Simply answer a few prompts about your project, and MDGenie creates professional documentation with customizable sections, badges, and formatting - saving you hours of manual README writing.
Installation
npm install -g mdgenieUsage
🔥Installation:
npm install -g mdgenie🏃Run MDGenie:
mdgenie(from any path, if you installed globally)
🤔Answer Prompts
MDGenie will ask you questions related to your project to help better understand it
🎁 Get your README
MDGenie will generate a professional project README.md file in your current directory.
Contributing
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
git clone https://github.com/slammers001/mdgenie.gitCredits
slammers001 - @slammers001
License
Distributed under the MIT License. See LICENSE for more information.
⭐ If you find this project helpful, please consider giving it a star!
Generated by MDGenie - Your README Generator
