The README Generator is a command-line application that dynamically generates a professional README.md file from a user's input using Node.js. This allows project creators to effortlessly create a well-organized README that includes all the essential sections needed for a good project documentation.
To install the necessary dependencies, run the following command:
npm install
After installing the dependencies, run the application with:
node index.js
Follow the prompts to enter project details which will be included in the README.md.
- Interactive prompts for project details.
- Supports multiple license badges.
- Automatically formats markdown file with Table of Contents.
- Easy to use with clear and concise setup steps.
This project is licensed under the MIT License - see the MIT License page for details.
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
To contribute:
- 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
To run tests, execute the following command:
npm test
For any questions or feedback, feel free to contact me:
- GitHub: GitHub
Here's a link to the project GitHub:
- GitHub: GitHub Link
Here's a demo video of the completed README Generator:
- Demo: Link to Demo