A command-line application that automatically generates professional README.md files for your projects. Save time and ensure consistency in your project documentation.
This Readme-Generator simplifies the process of creating README files. By providing key information about your project, the generator creates a structured and well-formatted README.md file, adhering to best practices for readability and clarity. This saves developers valuable time and helps maintain a consistent standard across all projects.
- Automated Generation: Quickly generates a complete README.md file based on user input.
- Customizable Sections: Allows you to specify details for various sections including project description, features, installation, technologies used, and licensing information.
- Professional Formatting: Produces a well-formatted and visually appealing README file following standard Markdown conventions.
- Command-line Interface: Easy to use and integrate into your existing development workflow.
- Error Handling: Provides informative error messages to guide users through the process.
- Clone the repository:
git clone <repository_url>
- Navigate to the project directory:
cd Readme-Generator - Install dependencies:
npm install
- Run the application:
The application will prompt you for the necessary information to generate your README. Follow the prompts carefully. The generated README.md file will be saved in the current directory.
node index.js // or use npm start if you have a start script defined in your package.json
- React.js
- Express.js
- Github API
- Gemini API
https://readme-generator-five-lovat.vercel.app
https://drive.google.com/file/d/1N79BG0WYybmSuUht8LjJ551DxY5T1eBH/view?usp=sharing