README-AI

Readme‑AI is a powerful open‑source CLI and web‑powered tool, built in Python, that automates the creation of comprehensive and well‑structured README.md files for software repositories. By analyzing a project’s code structure, metadata, and modules, it constructs detailed documentation enhanced with badges, TOC, installation instructions, usage examples, and more. It supports both online operation via LLM APIs (OpenAI, Anthropic, Gemini, Ollama) and an offline mode that produces boilerplate content without external calls . Installation is straightforward through pip (pip install readmeai), Docker, or clone and run. CLI options enable customization of templates, badge styles, emojis, logo inclusion, and backend LLM choice. Users can generate from local codebases or remote repositories and control scope via a .readmeaiignore file. The project is well‑maintained (2.3k★, 220 forks), offers a Streamlit web UI, and receives regular updates and community feedback .