About readmi ✨

What is readmi?

readmi is a powerful and user-friendly Node.js CLI tool that simplifies the process of creating professional README files for your projects. It helps developers save time and ensure their documentation is complete and well-structured.

With readmi, you can generate comprehensive README files in seconds, allowing you to focus on what matters most - your code.

Key Features

✅

Interactive CLI Tool

Uses Inquirer.js to guide users through simple, step-by-step prompts.

⚡

Instant README Generation

Quickly creates a clean, professional README.md file based on user input.

🧠

Smart Section Handling

Includes standard sections like Project Title, Description, Installation, Usage, License, Contributing, and more.

🎨

Styled Console Output

Uses Chalk.js to provide colorful and user-friendly terminal experience.

🛠️

Markdown-Powered Output

Generates fully structured Markdown for GitHub and other code platforms.

📁

File Creation or Overwrite Support

Detects and handles existing README files with care.

✏️

Customizable Content

Lets users input or skip optional sections like badges, screenshots, or FAQs.

🌐

Cross-Platform Compatibility

Works smoothly on macOS, Windows, and Linux terminals.

📦

Lightweight & Fast

Minimal dependencies, fast performance, and no bloat.

🔄

Repeatable & Reusable

Can be run across multiple projects for consistent documentation.

Getting Started

Installation is simple. Just run:

npm install -g @jayanithu/readmi

Before using readmi, you must configure your Google Generative API key:

Get your API key from Google AI Studio

Once installed and configured, you can generate a README by running:

readmi

Available Commands

readmi	Generate README for current project
readmi config	Manage configuration
-v, --version	Display version number
-h, --help	Show help information
--update	Update to latest version
-u, --update-readme	Smart README update mode
-sl, --select-language	Select README language
readmi config -r	Remove saved API key
readmi config -rm	Remove preferred model
readmi config -rl	Remove preferred language
readmi config -l	Set preferred language
readmi config model	Select preferred AI model

Why Use readmi?

A good README is essential for any project. It's often the first thing people see when they discover your repository. With readmi, you can ensure your projects always have professional, comprehensive documentation that helps users understand and use your code effectively.

Under Development

readmi is actively being improved with new features and enhancements. We have an exciting roadmap ahead and are working to make this tool even more powerful and user-friendly.

Your feedback is invaluable to us! If you have suggestions, feature requests, or encounter any issues, please don't hesitate to:

Open a pull request on our GitHub repository
Share your ideas through our Twitter or send an email to jayaniithu@gmail.com

We believe in the power of community-driven development and welcome contributions of all kinds, from code improvements to documentation updates and translations. If you found readmi useful, you might also be interested in my other npm packages that help streamline your development workflow.

Curious about readmi's journey? Check out our project roadmap and timeline to see the evolution of readmi from its initial development through all the major milestones, improvements, and features we've added along the way.