{"repo":"eli64s/readme-ai","free":true,"listed":false,"github":"https://github.com/eli64s/readme-ai","clone":"git clone https://github.com/eli64s/readme-ai.git","description":"README file generator, powered by AI.","language":"Python","stars":2969,"topics":["readme-generator","readme","readme-md-generator","ai","markdown","documentation","developer-tools","documentation-generator","python","markdown-generator"],"license":"MIT","category":"dev-tools","readme_excerpt":"Designed for simplicity, customization, and developer productivity. The metrics above are rendered with HyperWeave — an experimental SVG artifact layer for agents.   Explore → Quick Links - Intro - Demo - Features - Quickstart - Configuration - Example Gallery - Contributing Guidelines [!IMPORTANT] Explore the [Official Documentation][docs] for a complete list of features, customization options, and examples. Introduction ReadmeAI is a developer tool that automatically generates README files using a robust repository processing engine and advanced language models. Simply provide a URL or path to your codebase, and a well-structured and detailed README will be generated. Why Use ReadmeAI? This project aims to streamline the process of creating and maintaining documentation across all technical disciplines and experience levels. The core principles include: - 🔵 Automate: Generate detailed and structured README files with a single command. - ⚫️ Customize: Select from a variety of templates, styles, badges, and much more. - 🟣 Flexible: Switch between OpenAI , Ollama , Anthropic , and Gemini anytime. - 🟠 Language Agnostic: Compatible with a wide range of languages and frameworks. - 🟡 Best Practices: Ensure clean and consistent documentation across all projects. - 🟢 Smart Filtering: Intelligent file analysis with customizable .readmeaiignore patterns. - ⛔️ Offline Mode: Create README files offline, without using a LLM API service. Demo Run from your terminal: [readme","default_branch":null,"files":null,"tree":[],"storefront":"/r/eli64s","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/eli64s/readme-ai/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}