Unique-Readme-Generator

Auto README Generator is a command-line tool designed to simplify the creation of README files for your projects. By automating the process of generating a README, this tool helps ensure that your project's documentation is comprehensive and consistent.

Key Features Interactive CLI: Prompts users with a series of questions to gather essential information about their project. Customizable Output: Generates a README file in Markdown format based on user responses, including sections such as project name, description, installation instructions, usage guidelines, and license information. Markdown Formatting: Utilizes the Markdown-It library to format the README content, ensuring a clean and readable document. File Generation: Automatically creates a README.md file in the current directory with the provided project details. Usage Install the Tool:

Install the package globally using npm: npm i unique-readme-generator.

Execute generate-readme in your project directory to start the interactive prompt. Provide Project Information:

Answer the prompts with details about your project, including its name, description, installation steps, usage instructions, and license. Generate README:

The tool will create a README.md file with the provided information, formatted in Markdown. Example bash Copy code generate-readme Prompts:

What is the name of your project? Describe your project: What are the installation steps? How do you use the project? Which license does your project use? Output: A README.md file will be generated with sections filled out based on your responses.

Benefits

Efficiency: Saves time by automating README generation. Consistency: Ensures that all required sections are included in the README. User-Friendly: Easy to use with a simple command-line interface. Auto README Generator is ideal for developers looking to streamline their documentation process and maintain consistent project information.

Link

https://github.com/siddz415/auto-readme