# eli64s/readme-ai

README file generator, powered by AI.

Repository: https://github.com/eli64s/readme-ai
Canonical: https://ross.abutalabs.com/products/readme-ai
Homepage: https://eli64s.github.io/readme-ai/
Language: Python
License: MIT
License Family: permissive
Topics: readme-generator, readme, readme-md-generator, ai, markdown, documentation, developer-tools, documentation-generator, python, markdown-generator, devtools, readme-template, badge-generator, ai-documentation, anthropic, cli, gemini, gpt, agents, ai-agents
Last push: 2026-08-26T02:49:26+00:00

## Health v2 (maintenance only)
Score: 66/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 99, release rhythm 8, longevity 94
- inputs: {"age_days": 1325, "days_push": 7, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 2979, forks 296 (observed 2026-08-28T04:07:33.105239+00:00)

## What it is
ReadmeAI is a Python CLI tool that automatically generates README.md files for any codebase using large language models. It supports multiple LLM backends (OpenAI, Anthropic, Gemini, Ollama) and offers customizable templates, badges, and styling options.

## Use cases
- generate a readme for my github repo
- automatically create markdown documentation from a codebase
- bootstrap a professional README with badges and headers
- generate project documentation using an LLM
- create readme files for projects in any programming language
- document a repository with a local LLM via ollama

## When to choose
- you want to quickly scaffold a polished README for a new or existing repository
- you want AI-generated project summaries, installation steps, and usage sections
- you need language-agnostic documentation generation across many repos
- you prefer flexible LLM backends including local models via Ollama

## When to avoid
- you need hand-crafted, deeply reviewed documentation rather than AI-generated drafts
- you cannot or do not want to send code context to an LLM provider
- you need full API reference docs rather than a README overview

## Facets
- artifact type: cli-tool
- maturity: active
- function: documentation, llm-inference, cli, markdown
- domain: developer-tools, documentation, artificial-intelligence
- platform: python, cli, cross-platform
- tags: readme-generator, ai-documentation, badge-generator, openai, anthropic, gemini, ollama

## Member repositories
- eli64s/readme-ai (main) score 66

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:07:33.105239+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-29T18:47:28.002284+00:00, confidence not recorded.
  - readme: https://github.com/eli64s/readme-ai (fetched 2026-08-28T04:07:33.105239+00:00, sha f584f82ae8ab)
  - homepage: https://eli64s.github.io/readme-ai/ (fetched 2026-08-29T09:46:41.211634+00:00, sha 8c2cb1eb738d)
- Data as of 2026-08-30T08:39:29.467469+00:00.