Project Roadmap & Timeline ✨

A timeline of readmi's development journey and milestones.

Dec 6, 2025

🚀

v2.4.x Updates — CLI Improvements & Smart Features

  • ▸v2.4.8 — CLI output formatting and performance improvements.
  • ▸v2.4.7 — Documentation updates and build optimization.
  • ▸v2.4.6 — Smart README update mode with readmi -u command.
  • ▸Feature: Detect outdated information and selective section updates.
  • ▸Feature: Diff summary display for changes.
  • ▸Feature: Preserve custom sections during updates.
  • ▸Improvement: Enhanced CLI output formatting and error handling.
  • ▸Chore: Updated .npmignore for better package distribution.

Nov 23, 2025

🔧

v2.4.x Maintenance + Modular Refactor

  • ▸v2.4.5 — Version bump and small updates to version string.
  • ▸v2.4.4 — Version bump and small updates to version string.
  • ▸Documentation updates — README / docs clarifications.
  • ▸Feature: Users can select preferred AI model (new CLI option/config).
  • ▸Fix: Corrected CLI bin path in package.json.
  • ▸Refactor: Major modularization — added analyzer.js, config.js, generator.js, models.js.

Mar 28, 2025

🌐

v2.3.x Improvements (Prompts, Language Support)

  • ▸v2.3.2 / v2.3.1 — Version bumps and prompt improvements.
  • ▸v2.3.0 — Added language selection and configuration options.

Feb 26–25, 2025

⚡

Bun Support, Model Improvements, Dependency Updates

  • ▸Added Bun runtime support and enhanced prompts.
  • ▸Improved model-selection and configuration logic.
  • ▸Updated AI dependencies (e.g., Google Generative AI).

Earlier (Feb 2025 and Before)

🎯

Initial Development, First Publish, Early Features

  • ▸Initial project setup: base folder structure, package.json, CLI entry point.
  • ▸First working CLI command: initial readmi command ready.
  • ▸First publish to npm: made the package globally installable.
  • ▸Early prompt design used for README generation.
  • ▸Basic analyzer logic to scan project structure.
  • ▸Initial documentation covering installation and usage.
  • ▸Early cleanup: removed unused templates and experimental files.
  • ▸Fixes & small improvements to prompt, output formatting, and CLI reliability.

© 2025 @jayanithu/readmi