📘 readme-md-ai

⚡ A blazing fast, zero-config CLI tool to generate high-quality README.md files using OpenAI — right from your project's metadata.

---

🚀 Why use readme-md-ai?

• ✨ Instantly create clean, professional README.md files
• 🤖 Powered by OpenAI for intelligent content generation
• 📦 Auto-analyzes your project's package.json & metadata
• 💬 Interactive CLI prompts (powered by inquirer)
• 🎨 Offers multiple README templates: Minimal, Professional, and AI-style
• 🛠️ No boilerplate, no fuss — just install and run

---

📦 Installation

Install globally via npm:

1npm install -g readme-md-ai

Or install locally:

1npm install readme-md-ai --save-dev

---

⚙️ Usage

To generate a README.md for the current project:

1readme-md-ai --dir .

It will:

• Analyze your project metadata from package.json
• Ask you to choose a template
• Generate a ready-to-use README.md file in your project

---

🧰 CLI Options

Option	Description	Default
--dir or -d	Directory to scan	.

Example:

1readme-md-ai --dir ./my-project

---

🧠 How It Works

1. Scans the given directory for package.json
2. Extracts project name, description, scripts, and license
3. Prompts you to select one of the available README templates:
   • Minimal
   • Professional
   • Modern AI-style
4. Generates a clean, well-structured README.md using OpenAI and your metadata

🔧 Note: The "Modern AI-style" template is still under active development and may evolve.

---

📥 Contributing

We welcome contributions!
Please see CONTRIBUTING.md and our CODE_OF_CONDUCT.md for details.

---

🛠️ Built With

• commander
• inquirer
• chalk
• axios
• dotenv
• openai

---

🐛 Reporting Issues

Have a bug or idea? Open an issue:
👉 GitHub Issues

---

👤 Author

Manish Kumar Patel
GitHub: @its-maneeshk
npm: readme-md-ai

---

⭐️ Star on GitHub

If you found this helpful, consider starring the repo:
👉 https://github.com/its-maneeshk/readme-md-ai

---

📄 License

Licensed under the MIT License.