{"adoption": {"forks": 296, "observed_at": "2026-08-28T04:07:33.105239+00:00", "stars": 2979}, "canonical_url": "https://ross.abutalabs.com/products/readme-ai", "card": {"archived": false, "artifact_type": "cli-tool", "description": "README file generator, powered by AI.", "domain": ["developer-tools", "documentation", "artificial-intelligence"], "enriched": true, "function": ["documentation", "llm-inference", "cli", "markdown"], "health_score": 83, "homepage": "https://eli64s.github.io/readme-ai/", "language": "Python", "license": "MIT", "license_family": "permissive", "maturity": "active", "member_repos": ["eli64s/readme-ai"], "name": "eli64s/readme-ai", "platform": ["python", "cli", "cross-platform"], "pushed_at": "2026-08-26T02:49:26+00:00", "repo": "eli64s/readme-ai", "stars": 2979, "tags": ["readme-generator", "ai-documentation", "badge-generator", "openai", "anthropic", "gemini", "ollama"], "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"], "urls": [], "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"], "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.", "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"], "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"]}, "data_as_of": "2026-08-30T08:39:29.467469+00:00", "members": [{"path": "/products/readme-ai", "repo": "eli64s/readme-ai", "role": "main", "score": 66}], "provenance": {"archived": {"kind": "observed", "observed_at": "2026-08-28T04:07:33.105239+00:00", "source": "github"}, "artifact_type": {"confidence": null, "enriched_at": "2026-08-29T18:47:28.002284+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "f584f82ae8ab652e85601a56fcf66c243d846ceb315377a869f0984741f44392", "fetched_at": "2026-08-28T04:07:33.105239+00:00", "kind": "readme", "missing": false, "url": "https://github.com/eli64s/readme-ai"}, {"content_hash": "8c2cb1eb738df176c8363e8b5ca50515d26ef9687f793f172bd47f1c45a6e27c", "fetched_at": "2026-08-29T09:46:41.211634+00:00", "kind": "homepage", "missing": false, "url": "https://eli64s.github.io/readme-ai/"}], "taxonomy_version": 1}, "description": {"kind": "observed", "observed_at": "2026-08-28T04:07:33.105239+00:00", "source": "github"}, "domain": {"confidence": null, "enriched_at": "2026-08-29T18:47:28.002284+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "f584f82ae8ab652e85601a56fcf66c243d846ceb315377a869f0984741f44392", "fetched_at": "2026-08-28T04:07:33.105239+00:00", "kind": "readme", "missing": false, "url": "https://github.com/eli64s/readme-ai"}, {"content_hash": "8c2cb1eb738df176c8363e8b5ca50515d26ef9687f793f172bd47f1c45a6e27c", "fetched_at": "2026-08-29T09:46:41.211634+00:00", "kind": "homepage", "missing": false, "url": "https://eli64s.github.io/readme-ai/"}], "taxonomy_version": 1}, "enriched": {"inputs": [], "kind": "computed", "method": "enrichment_status"}, "function": {"confidence": null, "enriched_at": "2026-08-29T18:47:28.002284+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "f584f82ae8ab652e85601a56fcf66c243d846ceb315377a869f0984741f44392", "fetched_at": "2026-08-28T04:07:33.105239+00:00", "kind": "readme", "missing": false, "url": "https://github.com/eli64s/readme-ai"}, {"content_hash": "8c2cb1eb738df176c8363e8b5ca50515d26ef9687f793f172bd47f1c45a6e27c", "fetched_at": "2026-08-29T09:46:41.211634+00:00", "kind": "homepage", "missing": false, "url": "https://eli64s.github.io/readme-ai/"}], "taxonomy_version": 1}, "health_score": {"inputs": ["days_since_push", "days_since_release", "archived"], "kind": "computed", "method": "health_v1"}, "homepage": {"kind": "observed", "observed_at": "2026-08-28T04:07:33.105239+00:00", "source": "github"}, "language": {"kind": "observed", "observed_at": "2026-08-28T04:07:33.105239+00:00", "source": "github"}, "license": {"kind": "observed", "observed_at": "2026-08-28T04:07:33.105239+00:00", "source": "github"}, "license_family": {"inputs": ["license"], "kind": "computed", "method": "license_family"}, "maturity": {"confidence": null, "enriched_at": "2026-08-29T18:47:28.002284+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "f584f82ae8ab652e85601a56fcf66c243d846ceb315377a869f0984741f44392", "fetched_at": "2026-08-28T04:07:33.105239+00:00", "kind": "readme", "missing": false, "url": "https://github.com/eli64s/readme-ai"}, {"content_hash": "8c2cb1eb738df176c8363e8b5ca50515d26ef9687f793f172bd47f1c45a6e27c", "fetched_at": "2026-08-29T09:46:41.211634+00:00", "kind": "homepage", "missing": false, "url": "https://eli64s.github.io/readme-ai/"}], "taxonomy_version": 1}, "member_repos": {"kind": "observed", "observed_at": "2026-08-28T04:07:33.105239+00:00", "source": "github"}, "name": {"kind": "observed", "observed_at": "2026-08-28T04:07:33.105239+00:00", "source": "github"}, "platform": {"confidence": null, "enriched_at": "2026-08-29T18:47:28.002284+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "f584f82ae8ab652e85601a56fcf66c243d846ceb315377a869f0984741f44392", "fetched_at": "2026-08-28T04:07:33.105239+00:00", "kind": "readme", "missing": false, "url": "https://github.com/eli64s/readme-ai"}, {"content_hash": "8c2cb1eb738df176c8363e8b5ca50515d26ef9687f793f172bd47f1c45a6e27c", "fetched_at": "2026-08-29T09:46:41.211634+00:00", "kind": "homepage", "missing": false, "url": "https://eli64s.github.io/readme-ai/"}], "taxonomy_version": 1}, "pushed_at": {"kind": "observed", "observed_at": "2026-08-28T04:07:33.105239+00:00", "source": "github"}, "repo": {"kind": "observed", "observed_at": "2026-08-28T04:07:33.105239+00:00", "source": "github"}, "stars": {"kind": "observed", "observed_at": "2026-08-28T04:07:33.105239+00:00", "source": "github"}, "tags": {"confidence": null, "enriched_at": "2026-08-29T18:47:28.002284+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "f584f82ae8ab652e85601a56fcf66c243d846ceb315377a869f0984741f44392", "fetched_at": "2026-08-28T04:07:33.105239+00:00", "kind": "readme", "missing": false, "url": "https://github.com/eli64s/readme-ai"}, {"content_hash": "8c2cb1eb738df176c8363e8b5ca50515d26ef9687f793f172bd47f1c45a6e27c", "fetched_at": "2026-08-29T09:46:41.211634+00:00", "kind": "homepage", "missing": false, "url": "https://eli64s.github.io/readme-ai/"}], "taxonomy_version": 1}, "topics": {"kind": "observed", "observed_at": "2026-08-28T04:07:33.105239+00:00", "source": "github"}, "urls": {"kind": "observed", "observed_at": "2026-08-28T04:07:33.105239+00:00", "source": "github"}, "use_cases": {"confidence": null, "enriched_at": "2026-08-29T18:47:28.002284+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "f584f82ae8ab652e85601a56fcf66c243d846ceb315377a869f0984741f44392", "fetched_at": "2026-08-28T04:07:33.105239+00:00", "kind": "readme", "missing": false, "url": "https://github.com/eli64s/readme-ai"}, {"content_hash": "8c2cb1eb738df176c8363e8b5ca50515d26ef9687f793f172bd47f1c45a6e27c", "fetched_at": "2026-08-29T09:46:41.211634+00:00", "kind": "homepage", "missing": false, "url": "https://eli64s.github.io/readme-ai/"}], "taxonomy_version": 1}, "what_it_is": {"confidence": null, "enriched_at": "2026-08-29T18:47:28.002284+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "f584f82ae8ab652e85601a56fcf66c243d846ceb315377a869f0984741f44392", "fetched_at": "2026-08-28T04:07:33.105239+00:00", "kind": "readme", "missing": false, "url": "https://github.com/eli64s/readme-ai"}, {"content_hash": "8c2cb1eb738df176c8363e8b5ca50515d26ef9687f793f172bd47f1c45a6e27c", "fetched_at": "2026-08-29T09:46:41.211634+00:00", "kind": "homepage", "missing": false, "url": "https://eli64s.github.io/readme-ai/"}], "taxonomy_version": 1}, "when_to_avoid": {"confidence": null, "enriched_at": "2026-08-29T18:47:28.002284+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "f584f82ae8ab652e85601a56fcf66c243d846ceb315377a869f0984741f44392", "fetched_at": "2026-08-28T04:07:33.105239+00:00", "kind": "readme", "missing": false, "url": "https://github.com/eli64s/readme-ai"}, {"content_hash": "8c2cb1eb738df176c8363e8b5ca50515d26ef9687f793f172bd47f1c45a6e27c", "fetched_at": "2026-08-29T09:46:41.211634+00:00", "kind": "homepage", "missing": false, "url": "https://eli64s.github.io/readme-ai/"}], "taxonomy_version": 1}, "when_to_choose": {"confidence": null, "enriched_at": "2026-08-29T18:47:28.002284+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "f584f82ae8ab652e85601a56fcf66c243d846ceb315377a869f0984741f44392", "fetched_at": "2026-08-28T04:07:33.105239+00:00", "kind": "readme", "missing": false, "url": "https://github.com/eli64s/readme-ai"}, {"content_hash": "8c2cb1eb738df176c8363e8b5ca50515d26ef9687f793f172bd47f1c45a6e27c", "fetched_at": "2026-08-29T09:46:41.211634+00:00", "kind": "homepage", "missing": false, "url": "https://eli64s.github.io/readme-ai/"}], "taxonomy_version": 1}}, "score": {"components": {"activity": 99, "longevity": 94, "rhythm": 8}, "computed_at": "2026-09-03T02:20:16.233290+00:00", "flags": [], "formula": "round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)", "inputs": {"age_days": 1325, "days_push": 7, "days_rel": null, "gap_med": null, "n_releases_24m": 0}, "score": 66, "version": 2}, "staleness": {"enrichment_outdated": false, "low_confidence": false, "scrape_days": 9, "stale_scrape": false}}