{"id":13601364,"url":"https://github.com/eli64s/README-AI","last_synced_at":"2025-04-11T04:30:53.215Z","repository":{"id":150155886,"uuid":"589727205","full_name":"eli64s/readme-ai","owner":"eli64s","description":"README file generator, powered by AI.","archived":false,"fork":false,"pushed_at":"2025-03-18T19:05:27.000Z","size":258618,"stargazers_count":1911,"open_issues_count":37,"forks_count":195,"subscribers_count":16,"default_branch":"main","last_synced_at":"2025-04-10T00:14:00.249Z","etag":null,"topics":["agents","ai","ai-agents","ai-documentation","anthropic","badge-generator","cli","developer-tools","devtools","documentation","documentation-generator","gemini","gpt","markdown","markdown-generator","python","readme","readme-generator","readme-md-generator","readme-template"],"latest_commit_sha":null,"homepage":"https://eli64s.github.io/readme-ai/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eli64s.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-16T19:47:17.000Z","updated_at":"2025-04-09T20:29:04.000Z","dependencies_parsed_at":"2023-09-25T00:35:07.131Z","dependency_job_id":"e5cff75c-cf65-45db-a42a-f51af3f37bd4","html_url":"https://github.com/eli64s/readme-ai","commit_stats":{"total_commits":655,"total_committers":4,"mean_commits":163.75,"dds":"0.016793893129770976","last_synced_commit":"d9ae89fe5f5df05d494cebd7ff07065482d23f17"},"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eli64s%2Freadme-ai","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eli64s%2Freadme-ai/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eli64s%2Freadme-ai/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eli64s%2Freadme-ai/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eli64s","download_url":"https://codeload.github.com/eli64s/readme-ai/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248142942,"owners_count":21054671,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["agents","ai","ai-agents","ai-documentation","anthropic","badge-generator","cli","developer-tools","devtools","documentation","documentation-generator","gemini","gpt","markdown","markdown-generator","python","readme","readme-generator","readme-md-generator","readme-template"],"created_at":"2024-08-01T18:01:01.546Z","updated_at":"2025-04-11T04:30:53.203Z","avatar_url":"https://github.com/eli64s.png","language":"Python","readme":"\u003cdiv id=\"top\"\u003e\n\n\u003cp align=\"center\"\u003e\n\n\u003cpicture\u003e\n  \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://raw.githubusercontent.com/eli64s/readme-ai/main/docs/docs/assets/svg/logo-gradient.svg\"\u003e\n  \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://raw.githubusercontent.com/eli64s/readme-ai/main/docs/docs/assets/svg/logo-gradient.svg\"\u003e\n  \u003cimg alt=\"ReadmeAI Logo\" src=\"https://raw.githubusercontent.com/eli64s/readme-ai/main/docs/docs/assets/svg/logo-gradient.svg\" width=\"60%\"\u003e\n\u003c/picture\u003e\n\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cem\u003eDesigned for simplicity, customization, and developer productivity.\u003c/em\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/eli64s/readme-ai/actions\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/actions/workflow/status/eli64s/readme-ai/release-pipeline.yml?logo=githubactions\u0026label=CI\u0026logoColor=white\u0026color=4169E1\" alt=\"Github Actions\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://app.codecov.io/gh/eli64s/readme-ai\"\u003e\n    \u003cimg src=\"https://img.shields.io/codecov/c/github/eli64s/readme-ai?logo=codecov\u0026logoColor=white\u0026label=Coverage\u0026color=5D4ED3\" alt=\"Test Coverage\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://pypi.python.org/pypi/readmeai/\"\u003e\n    \u003cimg src=\"https://img.shields.io/pypi/v/readmeai?logo=Python\u0026logoColor=white\u0026label=PyPI\u0026color=7934C5\" alt=\"PyPI Version\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.pepy.tech/projects/readmeai\"\u003e\n    \u003cimg src=\"https://img.shields.io/pepy/dt/readmeai?logo=PyPI\u0026logoColor=white\u0026label=Downloads\u0026color=9400D3\" alt=\"Total Downloads\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://opensource.org/license/mit/\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/license/eli64s/readme-ai?logo=opensourceinitiative\u0026logoColor=white\u0026label=License\u0026color=8A2BE2\" alt=\"MIT License\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003c/div\u003e\n\n\u003cimg src=\"https://raw.githubusercontent.com/eli64s/readme-ai/eb2a0b4778c633911303f3c00f87874f398b5180/docs/docs/assets/svg/line-gradient.svg\" alt=\"line break\" width=\"100%\" height=\"3px\"\u003e\n\n## Quick Links\n\n- [Intro](#introduction)\n- [Demo](#demo)\n- [Features](#features)\n- [Quickstart](#getting-started)\n- [Configuration](#configuration)\n- [Example Gallery](#example-gallery)\n- [Contributing Guidelines](#contributing)\n\n\u003e [!IMPORTANT]\n\u003e Explore the [Official Documentation][docs] for a complete list of features, customization options, and examples.\n\n\u003cimg src=\"https://raw.githubusercontent.com/eli64s/readme-ai/eb2a0b4778c633911303f3c00f87874f398b5180/docs/docs/assets/svg/line-gradient.svg\" alt=\"line break\" width=\"100%\" height=\"3px\"\u003e\n\n## Introduction\n\nReadmeAI 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.\n\n**Why Use ReadmeAI?**\n\nThis project aims to streamline the process of creating and maintaining documentation across all technical disciplines and experience levels. The core principles include:\n\n- **🔵 Automate:** Generate detailed and structured README files with a single command.\n- **⚫️ Customize:** Select from a variety of templates, styles, badges, and much more.\n- **🟣 Flexible:** Switch between `OpenAI`, `Ollama`, `Anthropic`, and `Gemini` anytime.\n- **🟠 Language Agnostic:** Compatible with a wide range of languages and frameworks.\n- **🟡 Best Practices:** Ensure clean and consistent documentation across all projects.\n- **✨ Offline Mode:** Create README files offline, without using a LLM API service.\n\n## Demo\n\n**Run from your terminal:**\n\n[readmeai-cli-demo][cli-demo]\n\n\u003c!--\n**Run from your browser:**\n\n[readmeai-streamlit-demo][streamlit-demo]\n--\u003e\n\n\u003cimg src=\"https://raw.githubusercontent.com/eli64s/readme-ai/eb2a0b4778c633911303f3c00f87874f398b5180/docs/docs/assets/svg/line-gradient.svg\" alt=\"line break\" width=\"100%\" height=\"3px\"\u003e\n\n## Features\n\n### Customize Your README\n\nLet's begin by exploring various customization options and styles supported by ReadmeAI:\n\n\u003cdiv align=\"left\"\u003e\n  \u003ch6\u003eHeader Styles\u003c/h6\u003e\n  \u003ctable\u003e\n    \u003c!-- HEADER STYLES: CLASSIC --\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"left\"\u003e\n        \u003cimg src=\"https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/documentation/headers/variations/custom-dragon.png?raw=true\"\n             alt=\"Classic Header\"\n             width=\"800\"\n             style=\"border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px;\"\u003e\n        \u003cp align=\"left\"\u003e\u003cb\u003eCLI Command:\u003c/b\u003e\u003c/p\u003e\n        \u003cpre align=\"left\"\u003e\n          \u003ccode\u003e$ readmeai --repository https://github.com/eli64s/readme-ai-streamlit \\\n          \u0026emsp13;--logo custom \\\n          \u0026emsp13;--badge-color FF4B4B \\\n          \u0026emsp13;--badge-style flat-square \\\n          \u0026emsp13;--header-style classic\n          \u003c/code\u003e\n        \u003c/pre\u003e\n      \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003c!-- HEADER STYLES: MODERN --\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"left\"\u003e\n        \u003cimg src=\"https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/documentation/headers/variations/modern-for-the-badge.png?raw=true\"\n             alt=\"Modern Header\"\n             width=\"800\"\n             style=\"border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px;\"\u003e\n        \u003cp align=\"left\"\u003e\u003cb\u003eCLI Command:\u003c/b\u003e\u003c/p\u003e\n        \u003cpre align=\"left\"\u003e\n          \u003ccode\u003e$ readmeai --repository https://github.com/olliefr/docker-gs-ping \\\n          \u0026emsp13;--badge-color 00ADD8 \\\n          \u0026emsp13;--badge-style for-the-badge \\\n          \u0026emsp13;--header-style modern \\\n          \u0026emsp13;--navigation-style roman\n          \u003c/code\u003e\n        \u003c/pre\u003e\n      \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003c!-- HEADER STYLES: COMPACT --\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"left\"\u003e\n        \u003cimg src=\"https://github.com/eli64s/readme-ai/blob/main/docs/docs/examples/styling/headers/compact.png?raw=true\"\n          alt=\"Compact Header\"\n          width=\"800\"\n          style=\"border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px;\"\u003e\n        \u003cp align=\"left\"\u003e\u003cb\u003eCLI Command:\u003c/b\u003e\u003c/p\u003e\n        \u003cpre align=\"left\"\u003e\n          \u003ccode\u003e$ readmeai --repository https://github.com/rumaan/file.io-Android-Client \\\n          \u0026emsp13;--badge-style plastic \\\n          \u0026emsp13;--badge-color blueviolet \\\n          \u0026emsp13;--logo PURPLE \\\n          \u0026emsp13;--header-style COMPACT \\\n          \u0026emsp13;--navigation-style NUMBER \\\n          \u0026emsp13;--emojis solar\n          \u003c/code\u003e\n        \u003c/pre\u003e\n      \u003c/td\u003e\n    \u003c/tr\u003e\n  \u003c/table\u003e\n\n  \u003c!-- HEADER STYLES: BANNERS --\u003e\n  \u003ch3\u003eBanner Styles\u003c/h3\u003e\n  \u003ctable\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"left\"\u003e\n        \u003cimg src=\"https://github.com/eli64s/readme-ai/blob/main/docs/docs/examples/styling/headers/console.png?raw=true\"\n          alt=\"Console Header\"\n          width=\"800\"\n          style=\"border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px;\"\u003e\n        \u003cp align=\"left\"\u003e\u003cb\u003eCLI Command:\u003c/b\u003e\u003c/p\u003e\n        \u003cpre align=\"left\"\u003e\n          \u003ccode\u003e$ readmeai --repository https://github.com/emcf/thepipe \\\n          \u0026emsp13;--badge-style flat-square \\\n          \u0026emsp13;--badge-color 8a2be2 \\\n          \u0026emsp13;--header-style console \\\n          \u0026emsp13;--navigation-style accordion \\\n          \u0026emsp13;--emojis water\n          \u003c/code\u003e\n        \u003c/pre\u003e\n      \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003c!-- HEADER STYLES: SVG BANNER --\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"left\"\u003e\n        \u003cimg src=\"https://github.com/eli64s/readme-ai/blob/main/docs/docs/examples/styling/headers/svg-banner.png?raw=true\"\n          alt=\"SVG Banner\"\n          width=\"800\"\n          style=\"border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px;\"\u003e\n        \u003cp align=\"left\"\u003e\u003cb\u003eCLI Command:\u003c/b\u003e\u003c/p\u003e\n        \u003cpre align=\"left\"\u003e\n          \u003ccode\u003e$ readmeai --repository https://github.com/FerrariDG/async-ml-inference \\\n          \u0026emsp13;--badge-style plastic \\\n          \u0026emsp13;--badge-color 43a047 \\\n          \u0026emsp13;--header-style BANNER\n          \u003c/code\u003e\n        \u003c/pre\u003e\n      \u003c/td\u003e\n    \u003c/tr\u003e\n  \u003c/table\u003e\n\n  \u003c!-- ADDITIONAL STYLES --\u003e\n  \u003ch3\u003eAnd More!\u003c/h3\u003e\n  \u003ctable\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"left\" style=\"padding: 20px;\"\u003e\n        \u003cimg src=\"https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/project-overview/introduction.png?raw=true\"\n            alt=\"Project Overview\"\n            width=\"800\"\n            style=\"border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px; margin-bottom: 15px;\"\u003e\n        \u003cp align=\"left\" style=\"margin: 10px 0;\"\u003e\u003cb\u003eCLI Command:\u003c/b\u003e\u003c/p\u003e\n        \u003cpre align=\"left\"\u003e\n          \u003ccode\u003e$ readmeai --repository 'https://github.com/eli64sreadme-ai-streamlit' \\\n          \u0026emsp13;--badge-style FLAT-SQUARE \\\n          \u0026emsp13;--badge-color E92063 \\\n          \u0026emsp13;--header-style COMPACT \\\n          \u0026emsp13;--navigation-style ACCORDION \\\n          \u0026emsp13;--emojis RAINBOW \\\n          \u0026emsp13;--logo ICE\n          \u003c/code\u003e\n        \u003c/pre\u003e\n      \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003c!-- --\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"left\" style=\"padding: 20px;\"\u003e\n        \u003cimg src=\"https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/documentation/headers/variations/cloud.png?raw=true\"\n            alt=\"Custom Logo\"\n            width=\"800\"\n            style=\"border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px; margin-bottom: 15px;\"\u003e\n        \u003cp align=\"left\" style=\"margin: 10px 0;\"\u003e\u003cb\u003eCLI Command:\u003c/b\u003e\u003c/p\u003e\n        \u003cpre align=\"left\"\u003e\n          \u003ccode\u003e$ readmeai --repository https://github.com/jwills/buenavista \\\n          \u0026emsp13;--align LEFT \\\n          \u0026emsp13;--badge-style FLAT-SQUARE \\\n          \u0026emsp13;--logo CUSTOM\n          \u003c/code\u003e\n        \u003c/pre\u003e\n      \u003c/td\u003e\n    \u003c/tr\u003e\n  \u003c/table\u003e\n\n  \u003c!-- --\u003e\n  \u003c!-- \u003ctable\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"left\" width=\"50%\" style=\"padding: 20px;\"\u003e\n        \u003cimg src=\"https://raw.githubusercontent.com/eli64s/readme-ai/main/docs/docs/assets/img/headers/custom-balloon.png\"\n            alt=\"balloon-logo\"\n            width=\"100%\"\n            style=\"border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px; margin-bottom: 15px;\"\u003e\n        \u003cp align=\"left\" style=\"margin: 10px 0;\"\u003e\u003cb\u003eCLI Command:\u003c/b\u003e\u003c/p\u003e\n        \u003cpre align=\"left\"\u003e\u003ccode\u003e$ readmeai --repository https://github.com/eli64s/readme-ai-streamlit \\\n          \u0026emsp13;--badge-style flat \\\n          \u0026emsp13;--logo custom\u003c/code\u003e\u003c/pre\u003e\n        \u003cpre align=\"left\" style=\"margin-top: 10px;\"\u003e\u003ccode\u003e$ Provide an image file path or URL: \\\n          \u0026emsp13;https://www.svgrepo.com/show/395851/balloon.svg\u003c/code\u003e\u003c/pre\u003e\n      \u003c/td\u003e\n      \u003ctd align=\"left\" width=\"50%\" style=\"padding: 20px;\"\u003e\n        \u003cimg src=\"https://raw.githubusercontent.com/eli64s/readme-ai/main/docs/docs/assets/img/headers/skill-icons-light.png\"\n            alt=\"skill-icons\"\n            width=\"100%\"\n            style=\"border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px; margin-bottom: 15px;\"\u003e\n        \u003cp align=\"left\" style=\"margin: 10px 0;\"\u003e\u003cb\u003eCLI Command:\u003c/b\u003e\u003c/p\u003e\n        \u003cpre align=\"left\"\u003e\u003ccode\u003e$ readmeai --repository https://github.com/FerrariDG/async-ml-inference \\\n          \u0026emsp13;--badge-style skills-light \\\n          \u0026emsp13;--logo grey\u003c/code\u003e\u003c/pre\u003e\n      \u003c/td\u003e\n    \u003c/tr\u003e\n  \u003c/table\u003e\n\n  \u003ctable\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"left\" width=\"50%\" style=\"padding: 20px;\"\u003e\n        \u003cimg src=\"https://raw.githubusercontent.com/eli64s/readme-ai/main/docs/docs/assets/img/headers/compact.png\"\n            alt=\"compact-header\"\n            width=\"100%\"\n            style=\"border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px; margin-bottom: 15px;\"\u003e\n        \u003cp align=\"left\" style=\"margin: 10px 0;\"\u003e\u003cb\u003eCLI Command:\u003c/b\u003e\u003c/p\u003e\n        \u003cpre align=\"left\"\u003e\u003ccode\u003e$ readmeai --repository https://github.com/eli64s/readme-ai \\\n          \u0026emsp13;--logo cloud \\\n          \u0026emsp13;--header-style compact \\\n          \u0026emsp13;--navigation-style fold\u003c/code\u003e\u003c/pre\u003e\n      \u003c/td\u003e\n      \u003ctd align=\"left\" width=\"50%\" style=\"padding: 20px;\"\u003e\n        \u003cimg src=\"https://raw.githubusercontent.com/eli64s/readme-ai/refs/heads/main/docs/docs/assets/img/headers/modern-flat-square.png\"\n            alt=\"modern-style\"\n            width=\"100%\"\n            style=\"border: 1px solid #E7E9EB; border-radius: 5px; padding: 5px; margin-bottom: 15px;\"\u003e\n        \u003cp align=\"left\" style=\"margin: 10px 0;\"\u003e\u003cb\u003eCLI Command:\u003c/b\u003e\u003c/p\u003e\n        \u003cpre align=\"left\"\u003e\u003ccode\u003e$ readmeai --repository https://github.com/eli64s/readme-ai \\\n          \u0026emsp13;-i custom \\\n          \u0026emsp13;-bc BA0098 \\\n          \u0026emsp13;-bs flat-square \\\n          \u0026emsp13;-hs modern \\\n          \u0026emsp13;-ns fold\u003c/code\u003e\u003c/pre\u003e\n      \u003c/td\u003e\n    \u003c/tr\u003e\n  \u003c/table\u003e --\u003e\n\u003c/div\u003e\n\n### Generated Sections \u0026 Content\n\n\u003cdetails\u003e\u003csummary\u003e\u003cstrong\u003e꩜ Expand to view more!\u003c/strong\u003e\u003c/summary\u003e\u003cbr\u003e\n\n| \u003ch3\u003eProject Introduction\u003c/h3\u003e \u003cul\u003e\u003cli\u003eThis section captures your project's essence and value proposition. \u003c/li\u003e\u003cli\u003eThe prompt template used to generate this section can be viewed [here][prompts.toml]. \u003c/li\u003e\u003c/ul\u003e |\n| :--- |\n| ![][project-overview] |\n\n| \u003ch3\u003eFeatures Table\u003c/h3\u003e \u003cul\u003e\u003cli\u003eDetailed feature breakdown and technical capabilities. \u003c/li\u003e\u003cli\u003e The prompt template used to generate this section can be viewed [here][prompts.toml]. \u003c/li\u003e\u003c/ul\u003e |\n| :--- |\n| ![][features-table] |\n\n| \u003ch3\u003eProject Structure\u003c/h3\u003e \u003cul\u003e\u003cli\u003eVisual representation of your project's directory structure. \u003c/li\u003e\u003cli\u003eThe tree is generated using [pure Python][tree.py] and embedded in a code block. \u003c/li\u003e\u003c/ul\u003e |\n| :--- |\n| ![][project-structure] |\n| \u003ch3\u003eProject Index\u003c/h3\u003e \u003cul\u003e\u003cli\u003eSummarizes key modules of the project, which are also used as context for downstream [prompts.toml][prompts.toml]. \u003c/li\u003e\u003c/ul\u003e |\n| ![][project-index] |\n\n| \u003ch3\u003eGetting Started Guides\u003c/h3\u003e \u003cul\u003e\u003cli\u003eDependencies and system requirements are extracted from the codebase during preprocessing. \u003c/li\u003e\u003cli\u003eThe [parsers][readmeai.parsers] handle most of the heavy lifting here. \u003c/li\u003e\u003c/ul\u003e |\n| :--- |\n| ![][installation-steps] |\n| \u003ch3\u003eInstallation, Usage, \u0026 Testing\u003c/h3\u003e \u003cul\u003e\u003cli\u003eSetup instructions and usage guides are automatically created based on data extracted from the codebase. \u003c/li\u003e\u003c/ul\u003e |\n| ![][usage-guides] |\n\n| \u003ch3\u003eCommunity \u0026 Support\u003c/h3\u003e \u003cul\u003e\u003cli\u003eDevelopment roadmap, contribution guidelines, license information, and community resources. \u003c/li\u003e\u003cli\u003eA \u003cem\u003ereturn button\u003c/em\u003e is also included for easy navigation. \u003c/li\u003e\u003c/ul\u003e |\n| :--- |\n| ![][community-and-support] |\n| \u003ch3\u003eContribution Guides\u003c/h3\u003e \u003cul\u003e\u003cli\u003eInstructions for contributing to the project, including resource links and a basic contribution guide. \u003c/li\u003e\u003cli\u003eGraph of contributors is also included for open-source projects. \u003c/li\u003e\u003c/ul\u003e |\n| ![][contributing-guidelines] |\n\n\u003c/details\u003e\n\n\u003cimg src=\"https://raw.githubusercontent.com/eli64s/readme-ai/eb2a0b4778c633911303f3c00f87874f398b5180/docs/docs/assets/svg/line-gradient.svg\" alt=\"line break\" width=\"100%\" height=\"3px\"\u003e\n\n## Getting Started\n\n### Prerequisites\n\nReadmeAI requires Python 3.9 or higher, and one of the following installation methods:\n\n| Requirement                          | Details                          |\n|--------------------------------------|----------------------------------|\n| • [Python][python-link] ≥3.9         | Core runtime                     |\n| **Installation Method** (choose one) |                                  |\n| • [pip][pip-link]                    | Default Python package manager   |\n| • [pipx][pipx-link]                  | Isolated environment installer   |\n| • [uv][uv-link]                      | High-performance package manager |\n| • [docker][docker-link]              | Containerized environment        |\n\n### Supported Repository Platforms\n\nTo generate a README file, provide the source repository. ReadmeAI supports these platforms:\n\n| Platform                   | Details                   |\n|----------------------------|---------------------------|\n| [File System][file-system] | Local repository access   |\n| [GitHub][github]           | Industry-standard hosting |\n| [GitLab][gitlab]           | Full DevOps integration   |\n| [Bitbucket][bitbucket]     | Atlassian ecosystem       |\n\n### Supported LLM API Services\n\nReadmeAI is model agnostic, with support for the following LLM API services:\n\n| Provider                          | Best For        | Details                  |\n|-----------------------------------|-----------------|--------------------------|\n| [OpenAI][openai]                  | General use     | Industry-leading models  |\n| [Anthropic][anthropic]            | Advanced tasks  | Claude language models   |\n| [Google Gemini][gemini]           | Multimodal AI   | Latest Google technology |\n| [Ollama][ollama]                  | Open source     | No API key needed        |\n| [Offline Mode][README-Offline.md] | Local operation | No internet required     |\n\n---\n\n### Installation\n\nReadmeAI is available on [PyPI][pypi-link] as readmeai and can be installed as follows:\n\n\u003c!-- #### Using `pip` [![pypi][pypi-shield]][pypi-link] --\u003e\n\u003c!-- #### ![pip][python-svg]{ width=\"2%\" }\u0026emsp13;Pip --\u003e\n#### \u003cimg width=\"2%\" src=\"https://simpleicons.org/icons/python.svg\"\u003e\u0026emsp13;Pip\n\nInstall with pip (recommended for most users):\n\n```sh\n❯ pip install -U readmeai\n```\n\n\u003c!-- #### Using `pipx` [![pipx][pipx-shield]][pipx-link] --\u003e\n\u003c!-- #### ![pipx][pipx-svg]{ width=\"2%\" }\u0026emsp13;Pipx --\u003e\n#### \u003cimg width=\"2%\" src=\"https://simpleicons.org/icons/pipx.svg\"\u003e\u0026emsp13;Pipx\n\nWith `pipx`, readmeai will be installed in an isolated environment:\n\n```sh\n❯ pipx install readmeai\n```\n\n\u003c!-- #### ![uv][uv-svg]{ width=\"2%\" }\u0026emsp13;Uv --\u003e\n#### \u003cimg width=\"2%\" src=\"https://simpleicons.org/icons/uv.svg\"\u003e\u0026emsp13;Uv\n\nThe fastest way to install readmeai is with [uv][uv-link]:\n\n```sh\n❯ uv tool install readmeai\n```\n\n\u003c!-- #### Using `docker` [![docker][docker-shield]][docker-link] --\u003e\n\u003c!-- #### ![docker][docker-svg]{ width=\"2%\" }\u0026emsp13;Docker --\u003e\n#### \u003cimg width=\"2%\" src=\"https://simpleicons.org/icons/docker.svg\"\u003e\u0026emsp13;Docker\n\nTo run `readmeai` in a containerized environment, pull the latest image from [Docker Hub][dockerhub-link]:\n\n```sh\n❯ docker pull zeroxeli/readme-ai:latest\n```\n\n\u003c!-- #### ![build-from-source][git-svg]{ width=\"2%\" }\u0026emsp13;From source --\u003e\n#### \u003cimg width=\"2%\" src=\"https://simpleicons.org/icons/git.svg\"\u003e\u0026emsp13;From source\n\n\u003cdetails\u003e\u003csummary\u003e\u003ci\u003eClick to build \u003ccode\u003ereadmeai\u003c/code\u003e from source\u003c/i\u003e\u003c/summary\u003e\n\n1. **Clone the repository:**\n\n    ```sh\n    ❯ git clone https://github.com/eli64s/readme-ai\n    ```\n\n2. **Navigate to the project directory:**\n\n    ```sh\n    ❯ cd readme-ai\n    ```\n\n3. **Install dependencies:**\n\n    ```sh\n    ❯ pip install -r setup/requirements.txt\n    ```\n\nAlternatively, use the [setup script][setup-script] to install dependencies:\n\n\u003c!-- #### ![bash][bash-svg]{ width=\"2%\" }\u0026emsp13;Bash --\u003e\n##### \u003cimg width=\"1.5%\" src=\"https://simpleicons.org/icons/gnubash.svg\"\u003e\u0026emsp13;Bash\n\n1. **Run the setup script:**\n\n    ```sh\n    ❯ bash setup/setup.sh\n    ```\n\nOr, use `poetry` to build and install project dependencies:\n\n\u003c!-- #### ![poetry][poetry-svg]{ width=\"2%\" }\u0026emsp13;Poetry --\u003e\n##### \u003cimg width=\"1.5%\" src=\"https://simpleicons.org/icons/poetry.svg\"\u003e\u0026emsp13;Poetry\n\n1. **Install dependencies with poetry:**\n\n    ```sh\n    ❯ poetry install\n    ```\n\n\u003c/details\u003e\n\u003cbr\u003e\n\n### Additional Optional Dependencies\n\n\u003e [!IMPORTANT]\n\u003e To use the **Anthropic** and **Google Gemini** clients, extra dependencies are required. Install the package with the following extras:\n\u003e\n\u003e - **Anthropic:**\n\u003e   ```sh\n\u003e   ❯ pip install \"readmeai[anthropic]\"\n\u003e   ```\n\u003e - **Google Gemini:**\n\u003e   ```sh\n\u003e   ❯ pip install \"readmeai[google-generativeai]\"\n\u003e   ```\n\u003e\n\u003e - **Install Multiple Clients:**\n\u003e   ```sh\n\u003e   ❯ pip install \"readmeai[anthropic,google-generativeai]\"\n\u003e   ```\n\n### Usage\n\n#### Set your API key\n\nWhen running `readmeai` with a third-party service, you must provide a valid API key. For example, the `OpenAI` client is set as follows:\n\n```sh\n❯ export OPENAI_API_KEY=\u003cyour_api_key\u003e\n\n# For Windows users:\n❯ set OPENAI_API_KEY=\u003cyour_api_key\u003e\n```\n\n\u003cdetails closed\u003e\u003csummary\u003eClick to view environment variables for - \u003ccode\u003eOllama\u003c/code\u003e, \u003ccode\u003eAnthropic\u003c/code\u003e, \u003ccode\u003eGoogle Gemini\u003c/code\u003e\u003c/summary\u003e\n\u003cbr\u003e\n\u003cdetails closed\u003e\u003csummary\u003eOllama\u003c/summary\u003e\n\u003cbr\u003e\n\nRefer to the [Ollama documentation][ollama] for more information on setting up the Ollama server.\n\nTo start, follow these steps:\n\n1. Pull your model of choice from the Ollama repository:\n\n\t```sh\n\t❯ ollama pull llama3.2:latest\n\t```\n\n2. Start the Ollama server and set the `OLLAMA_HOST` environment variable:\n\n\t```sh\n\t❯ export OLLAMA_HOST=127.0.0.1 \u0026\u0026 ollama serve\n\t```\n\n\u003c/details\u003e\n\u003cdetails closed\u003e\u003csummary\u003eAnthropic\u003c/summary\u003e\n\n1. Export your Anthropic API key:\n\n\t```sh\n\t❯ export ANTHROPIC_API_KEY=\u003cyour_api_key\u003e\n\t```\n\n\u003c/details\u003e\n\u003cdetails closed\u003e\u003csummary\u003eGoogle Gemini\u003c/summary\u003e\n\n1. Export your Google Gemini API key:\n\n\t```sh\n\t❯ export GOOGLE_API_KEY=\u003cyour_api_key\n\t```\n\n\u003c/details\u003e\n\u003c/details\u003e\n\n#### Using the CLI\n\n##### Running with a LLM API service\n\nBelow is the minimal command required to run `readmeai` using the `OpenAI` client:\n\n```sh\n❯ readmeai --api openai -o readmeai-openai.md -r https://github.com/eli64s/readme-ai\n```\n\n\u003e [!IMPORTANT]\n\u003e The default model set is `gpt-3.5-turbo`, offering the best balance between cost and performance.When using any model from the `gpt-4` series and up, please monitor your costs and usage to avoid unexpected charges.\n\nReadmeAI can easily switch between API providers and models. We can run the same command as above with the `Anthropic` client:\n```sh\n❯ readmeai --api anthropic -m claude-3-5-sonnet-20240620 -o readmeai-anthropic.md -r https://github.com/eli64s/readme-ai\n```\n\nAnd finally, with the `Google Gemini` client:\n\n```sh\n❯ readmeai --api gemini -m gemini-1.5-flash -o readmeai-gemini.md -r https://github.com/eli64s/readme-ai\n```\n\n##### Running with local models\n\nWe can also run `readmeai` with free and open-source locally hosted models using the Ollama:\n\n```sh\n❯ readmeai --api ollama --model llama3.2 -r https://github.com/eli64s/readme-ai\n```\n\n##### Running on a local codebase\n\nTo generate a README file from a local codebase, simply provide the full path to the project:\n\n```sh\n❯ readmeai --repository /users/username/projects/myproject --api openai\n```\n\nAdding more customization options:\n\n```sh\n❯ readmeai --repository https://github.com/eli64s/readme-ai \\\n           --output readmeai.md \\\n           --api openai \\\n           --model gpt-4 \\\n           --badge-color A931EC \\\n           --badge-style flat-square \\\n           --header-style compact \\\n           --navigation-style fold \\\n           --temperature 0.9 \\\n           --tree-depth 2\n           --logo LLM \\\n           --emojis solar\n```\n\n##### Running in offline mode\n\nReadmeAI supports `offline mode`, allowing you to generate README files without using a LLM API service.\n\n```sh\n❯ readmeai --api offline -o readmeai-offline.md -r https://github.com/eli64s/readme-ai\n```\n\n\u003c!-- #### ![docker][docker-svg]{ width=\"2%\" }\u0026emsp13;Docker --\u003e\n#### \u003cimg width=\"2%\" src=\"https://simpleicons.org/icons/docker.svg\"\u003e\u0026emsp13;Docker\n\nRun the `readmeai` CLI in a Docker container:\n\n```sh\n❯ docker run -it --rm \\\n    -e OPENAI_API_KEY=$OPENAI_API_KEY \\\n    -v \"$(pwd)\":/app zeroxeli/readme-ai:latest \\\n    --repository https://github.com/eli64s/readme-ai \\\n    --api openai\n```\n\n\u003c!-- #### ![streamlit][streamlit-svg]{ width=\"2%\" }\u0026emsp13;Streamlit --\u003e\n#### \u003cimg width=\"2%\" src=\"https://simpleicons.org/icons/streamlit.svg\"\u003e\u0026emsp13;Streamlit\n\nTry readme-ai directly in your browser on Streamlit Cloud, no installation required.\n\n[\u003cimg align=\"center\" src=\"https://static.streamlit.io/badges/streamlit_badge_black_white.svg\" width=\"20%\"\u003e](https://readme-ai.streamlit.app/)\n\nSee the [readme-ai-streamlit][readme-ai-streamlit] repository on GitHub for more details about the application.\n\n\u003e [!WARNING]\n\u003e The readme-ai Streamlit web app may not always be up-to-date with the latest features. Please use the command-line interface (CLI) for the most recent functionality.\n\n\u003c!-- #### ![build-from-source][git-svg]{ width=\"2%\" }\u0026emsp13;From source --\u003e\n#### \u003cimg width=\"2%\" src=\"https://simpleicons.org/icons/git.svg\"\u003e\u0026emsp13;From source\n\n\u003cdetails\u003e\u003csummary\u003e\u003ci\u003eClick to run \u003ccode\u003ereadmeai\u003c/code\u003e from source\u003c/i\u003e\u003c/summary\u003e\n\n\u003c!-- #### ![bash][bash-svg]{ width=\"2%\" }\u0026emsp13;Bash --\u003e\n##### \u003cimg width=\"1.5%\" src=\"https://simpleicons.org/icons/gnubash.svg\"\u003e\u0026emsp13;Bash\n\nIf you installed the project from source with the bash script, run the following command:\n\n1. Activate the virtual environment:\n\n   ```sh\n   ❯ conda activate readmeai\n   ```\n\n2. Run the CLI:\n\n   ```sh\n   ❯ python3 -m readmeai.cli.main -r https://github.com/eli64s/readme-ai\n\t```\n\n\u003c!-- #### ![poetry][poetry-svg]{ width=\"2%\" }\u0026emsp13;Poetry --\u003e\n##### \u003cimg width=\"1.5%\" src=\"https://simpleicons.org/icons/poetry.svg\"\u003e\u0026emsp13;Poetry\n\n1. Activate the virtual environment:\n\n   ```sh\n   ❯ poetry shell\n   ```\n\n2. Run the CLI:\n\n   ```sh\n   ❯ poetry run python3 -m readmeai.cli.main -r https://github.com/eli64s/readme-ai\n   ```\n\n\u003c/details\u003e\n\n\u003cimg src=\"https://raw.githubusercontent.com/eli64s/readme-ai/eb2a0b4778c633911303f3c00f87874f398b5180/docs/docs/assets/svg/line-gradient.svg\" alt=\"line break\" width=\"100%\" height=\"3px\"\u003e\n\n### Testing\n\n\u003c!-- #### Using `pytest` [![pytest][pytest-shield]][pytest-link] --\u003e\n\nThe [pytest][pytest-link] and [nox][nox-link] frameworks are used for development and testing.\n\nInstall the dependencies with uv:\n\n```sh\n❯ uv pip install --dev --group test --all-extras\n```\n\nRun the unit test suite using Pytest:\n\n```sh\n❯ make test\n```\n\nUsing nox, test the app against Python versions `3.9`, `3.10`, `3.11`, and `3.12`:\n\n```sh\n❯ make test-nox\n```\n\n\u003e [!TIP]\n\u003e \u003csub\u003eNox is an automation tool for testing applications in multiple environments. This helps ensure your project is compatible with across Python versions and environments.\u003c/sub\u003e\n\n\u003cimg src=\"https://raw.githubusercontent.com/eli64s/readme-ai/eb2a0b4778c633911303f3c00f87874f398b5180/docs/docs/assets/svg/line-gradient.svg\" alt=\"line break\" width=\"100%\" height=\"3px\"\u003e\n\n## Configuration\n\nCustomize your README generation with a variety of options and style settings supported such as:\n\n| Option               | Description                                   | Default         |\n|----------------------|-----------------------------------------------|-----------------|\n| `--align`            | Text alignment in header                      | `center`        |\n| `--api`              | LLM API service provider                      | `offline`       |\n| `--badge-color`      | Badge color name or hex code                  | `0080ff`        |\n| `--badge-style`      | Badge icon style type                         | `flat`          |\n| `--header-style`     | Header template style                         | `classic`       |\n| `--navigation-style` | Table of contents style                       | `bullet`        |\n| `--emojis`           | Emoji theme packs prefixed to section titles  | `None`          |\n| `--logo`             | Project logo image                            | `blue`          |\n| `--logo-size`        | Logo image size                               | `30%`           |\n| `--model`            | Specific LLM model to use                     | `gpt-3.5-turbo` |\n| `--output`           | Output filename                               | `readme-ai.md`  |\n| `--repository`       | Repository URL or local directory path        | `None`          |\n| `--temperature`      | Creativity level for content generation       | `0.1`           |\n| `--tree-max-depth`   | Maximum depth of the directory tree structure | `2`             |\n\nRun the following command to view all available options:\n\n```sh\n❯ readmeai --help\n```\n\n\u003csub\u003e\n\nVisit the [Official Documentation][docs] for a complete guide on configuring and customizing README files.\n\n\u003c/sub\u003e\n\n\u003cimg src=\"https://raw.githubusercontent.com/eli64s/readme-ai/eb2a0b4778c633911303f3c00f87874f398b5180/docs/docs/assets/svg/line-gradient.svg\" alt=\"line break\" width=\"100%\" height=\"3px\"\u003e\n\n## Example Gallery\n\nThis gallery showcases a diverse collection of README examples generated across various programming languages, frameworks, and project types.\n\n| Tech                | Repository              | README                 | Project Description        |\n|:--------------------|:------------------------|:-----------------------|:---------------------------|\n| Python              | [README-Python.md]      | [readmeai]             | ReadmeAI's core project    |\n| Apache Flink        | [README-Flink.md]       | [pyflink-poc]          | PyFlink proof of concept   |\n| Streamlit           | [README-Streamlit.md]   | [readmeai-streamlit]   | Web application interface  |\n| Vercel \u0026 NPM        | [README-Vercel.md]      | [github-readme-quotes] | Deployment showcase        |\n| Go \u0026 Docker         | [README-DockerGo.md]    | [docker-gs-ping]       | Containerized Golang app   |\n| FastAPI \u0026 Redis     | [README-FastAPI.md]     | [async-ml-inference]   | ML inference service       |\n| Java                | [README-Java.md]        | [minimal-todo]         | Minimalist To-Do app       |\n| PostgreSQL \u0026 DuckDB | [README-PostgreSQL.md]  | [buenavista]           | Database proxy server      |\n| Kotlin              | [README-Kotlin.md]      | [android-client]       | Mobile client application  |\n| Offline Mode        | [README-Offline.md] | [litellm]              | Offline functionality demo |\n\n### Community Contribution\n\n#### Share Your README Files\n\nWe invite developers to share their generated README files in our [Show \u0026 Tell][show-and-tell] discussion category. Your contributions help:\n\n- Showcase diverse documentation styles\n- Provide real-world examples\n- Help improve the ReadmeAI tool\n\nFind additional README examples in our [examples directory][examples-directory] on GitHub.\n\n\u003cimg src=\"https://raw.githubusercontent.com/eli64s/readme-ai/eb2a0b4778c633911303f3c00f87874f398b5180/docs/docs/assets/svg/line-gradient.svg\" alt=\"line break\" width=\"100%\" height=\"3px\"\u003e\n\n## Roadmap\n\n* [ ] Release `readmeai 1.0.0` with robust documentation creation and maintenance capabilities.\n* [ ] Extend template support for various `project types` and `programming languages`.\n* [ ] Develop `Vscode Extension` to generate README files directly in the editor.\n* [ ] Develop `GitHub Actions` to automate documentation updates.\n* [ ] Add `badge packs` to provide additional badge styles and options.\n  + [ ] Code coverage, CI/CD status, project version, and more.\n\n## Contributing\n\nContributions are welcome! Please read the [Contributing Guide][contributing] to get started.\n\n- **💡 [Contributing Guide][contributing]**: Learn about our contribution process and coding standards.\n- **🐛 [Report an Issue][github-issues]**: Found a bug? Let us know!\n- **💬 [Start a Discussion][github-discussions]**: Have ideas or suggestions? We'd love to hear from you.\n\n\u003cbr\u003e\n\n\u003cp align=\"left\"\u003e\n  \u003ca href=\"https://github.com{/eli64s/readme-ai/}graphs/contributors\"\u003e\n    \u003cimg src=\"https://contrib.rocks/image?repo=eli64s/readme-ai\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n## Acknowledgments\n\nA big shoutout to the projects below for their awesome work and open-source contributions:\n\n\u003cdiv style=\"display: flex; align-items: left;\"\u003e\n  \u003ca href=\"https://shields.io/\"\u003e\n    \u003cimg src=\"https://avatars.githubusercontent.com/u/6254238?s=200\u0026v=4\" alt=\"shields.io\" style=\"width: 50px; margin-right: 10px;\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://simpleicons.org/\"\u003e\n    \u003cimg src=\"https://avatars.githubusercontent.com/u/29872746?s=200\u0026v=4\" alt=\"simpleicons.org\" style=\"width: 50px; margin-right: 10px;\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/tandpfun/skill-icons\"\u003e\n    \u003cimg src=\"https://avatars.githubusercontent.com/u/28990589?v=4\" alt=\"tandpfun/skill-icons\" style=\"width: 50px; margin-right: 10px;\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/astrit/css.gg\"\u003e\n    \u003cimg src=\"https://avatars.githubusercontent.com/u/2398447?v=4\" alt=\"astrit/css.gg\" style=\"width: 50px; margin-right: 10px;\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/Ileriayo/markdown-badges\"\u003e\n    \u003cimg src=\"https://avatars.githubusercontent.com/u/31800695?v=4\" alt=\"Ileriayo/markdown-badges\" style=\"width: 50px; margin-right: 10px;\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/Ileriayo/markdown-badges\"\u003e\n    \u003cimg src=\"https://avatars.githubusercontent.com/u/13166712?v=4\" alt=\"Ileriayo/markdown-badges\" style=\"width: 50px; margin-right: 10px;\"\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n## 🎗 License\n\nCopyright © 2023-2025 [readme-ai][readme-ai]. \u003cbr /\u003e\nReleased under the [MIT][license] license.\n\n\u003cdiv align=\"left\"\u003e\n\n[![][to-the-top]](#top)\n\n\u003c/div\u003e\n\n\u003cimg src=\"https://raw.githubusercontent.com/eli64s/readme-ai/eb2a0b4778c633911303f3c00f87874f398b5180/docs/docs/assets/svg/line-gradient.svg\" alt=\"line break\" width=\"100%\" height=\"3px\"\u003e\n\n\u003c!-- REFERENCE LINKS --\u003e\n\u003c!-- README-AI RESOURCES --\u003e\n[readme-ai]: https://github.com/eli64s/readme-ai\n[readme-ai-streamlit]: https://github.com/eli64s/readme-ai-streamlit\n[actions]: https://github.com/eli64s/readme-ai/actions\n[codecov]: https://app.codecov.io/gh/eli64s/readme-ai\n[docs]: https://eli64s.github.io/readme-ai\n[github-discussions]: https://github.com/eli64s/readme-ai/discussions\n[github-issues]: https://github.com/eli64s/readme-ai/issues\n[github-pulls]: https://github.com/eli64s/readme-ai/pulls\n[mit]: https://opensource.org/license/mit\n[pepy]: https://www.pepy.tech/projects/readmeai\n[contributing]: https://github.com/eli64s/readme-ai/blob/main/CONTRIBUTING.md\n[license]: https://github.com/eli64s/readme-ai/blob/main/LICENSE\n[to-the-top]: https://img.shields.io/badge/Return-5D4ED3?style=flat\u0026logo=ReadMe\u0026logoColor=white\n\n\u003c!-- README-AI DEMOS --\u003e\n[cli-demo]: https://github.com/user-attachments/assets/e1198922-5233-4a44-a5a8-15fa1cc4e2d7\n[streamlit-demo]: https://github.com/user-attachments/assets/c3f60665-4768-4baa-8e31-6b6e8c4c9248\n\n\u003c!-- THIRD-PARTY RESOURCES --\u003e\n[docker-shield]: https://img.shields.io/badge/Docker-2496ED.svg?style=flat\u0026logo=Docker\u0026logoColor=white\n[docker-link]: https://hub.docker.com/r/zeroxeli/readme-ai\n[python-link]: https://www.python.org/\n[pip-link]: https://pip.pypa.io/en/stable/\n[pypi-shield]: https://img.shields.io/badge/PyPI-3775A9.svg?style=flat\u0026logo=PyPI\u0026logoColor=white\n[pypi-link]: https://pypi.org/project/readmeai/\n[pipx-shield]: https://img.shields.io/badge/pipx-2CFFAA.svg?style=flat\u0026logo=pipx\u0026logoColor=black\n[pipx-link]: https://pipx.pypa.io/stable/\n[uv-link]: https://docs.astral.sh/uv/\n[pytest-shield]: https://img.shields.io/badge/Pytest-0A9EDC.svg?style=flat\u0026logo=Pytest\u0026logoColor=white\n[pytest-link]: https://docs.pytest.org/en/7.1.x/contents.html\n[nox-link]: https://nox.thea.codes/en/stable/\n[streamlit-link]: https://readme-ai.streamlit.app/\n\n\u003c!-- BADGES \u0026 ICONS --\u003e\n[shieldsio]: https://shields.io/\n[simple-icons]: https://simpleicons.org/\n[skill-icons]: https://github.com/tandpfun/skill-icons\n[github-profile-badges]: https://github.com/Aveek-Saha/GitHub-Profile-Badges\n[markdown-badges]: https://github.com/Ileriayo/markdown-badges\n[css-icons]: https://github.com/astrit/css.gg\n\n\u003c!-- SIMPLE ICONS --\u003e\n[python-svg]: https://simpleicons.org/icons/python.svg\n[pipx-svg]: https://simpleicons.org/icons/pipx.svg\n[uv-svg]: https://simpleicons.org/icons/astral.svg\n[docker-svg]: https://simpleicons.org/icons/docker.svg\n[git-svg]: https://simpleicons.org/icons/git.svg\n[bash-svg]: https://simpleicons.org/icons/gnubash.svg\n[poetry-svg]: https://simpleicons.org/icons/poetry.svg\n[streamlit-svg]: https://simpleicons.org/icons/streamlit.svg\n\n\u003c!-- GIT HOST PROVIDERS --\u003e\n[file-system]: https://en.wikipedia.org/wiki/File_system\n[github]: https://github.com/\n[gitlab]: https://gitlab.com/\n[bitbucket]: https://bitbucket.org/\n\n\u003c!-- LLM API PROVIDERS --\u003e\n[anthropic]: https://docs.anthropic.com/en/home\n[gemini]: https://ai.google.dev/tutorials/python_quickstart\n[ollama]: https://github.com/ollama/ollama\n[openai]: https://platform.openai.com/docs/quickstart/account-setup:\n\n\u003c!-- EXAMPLES --\u003e\n\u003c!-- FEATURES --\u003e\n[project-overview]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/project-overview/introduction.png?raw=true\n[features-table]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/features/features.png?raw=true\n[project-structure]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/project-structure/project-structure.png?raw=true\n[project-index]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/project-structure/project-index.png?raw=true\n[installation-steps]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/getting-started/installation-steps.png?raw=true\n[usage-guides]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/getting-started/usage-guides.png?raw=true\n[community-and-support]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/community/community-and-support.png?raw=true\n[contributing-guidelines]: https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/community/contributing-guidelines.png?raw=true\n[readmeai.parsers]: https://github.com/eli64s/readme-ai/tree/main/readmeai/parsers\n[tree.py]: https://github.com/eli64s/readme-ai/blob/main/readmeai/generators/tree.py\n[prompts.toml]: https://github.com/eli64s/readme-ai/blob/main/readmeai/config/settings/prompts.toml\n\n\u003c!-- EXAMPLES: INPUT REPOSITORY LINKS --\u003e\n[readmeai]: https://github.com/eli64s/readme-ai\n[pyflink-poc]: https://github.com/eli64s/pyflink-poc\n[readmeai-streamlit]: https://github.com/eli64s/readme-ai-streamlit\n[github-readme-quotes]: https://github.com/PiyushSuthar/github-readme-quotes\n[docker-gs-ping]: https://github.com/olliefr/docker-gs-ping\n[async-ml-inference]: https://github.com/FerrariDG/async-ml-inference\n[minimal-todo]: https://github.com/avjinder/Minimal-Todo\n[buenavista]: https://github.com/jwills/buenavista\n[android-client]: https://github.com/rumaan/file.io-Android-Client\n[litellm]: https://github.com/BerriAI/litellm\n\n\u003c!-- EXAMPLES: OUTPUT README FILE LINKS --\u003e\n[README-Python.md]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-ai.md\n[README-Flink.md]: https://github.com/eli64s/readme-ai/blob/main/examples/headers/modern.md\n[README-Streamlit.md]: https://github.com/eli64s/readme-ai/blob/main/examples/banners/svg-banner.md\n[README-Vercel.md]: https://github.com/eli64s/readme-ai/blob/main/examples/logos/dalle.md\n[README-DockerGo.md]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-docker-go.md\n[README-FastAPI.md]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-fastapi-redis.md\n[README-Java.md]: https://github.com/eli64s/readme-ai/blob/main/examples/headers/compact.md\n[README-PostgreSQL.md]: https://github.com/eli64s/readme-ai/blob/main/examples/headers/classic.md\n[README-Kotlin.md]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-kotlin.md\n[README-Offline.md]: https://github.com/eli64s/readme-ai/blob/main/examples/offline-mode/readme-litellm.md\n\n\u003c!-- EXAMPLES: OTHER RESOURCES --\u003e\n[examples-directory]: https://github.com/eli64s/readme-ai/tree/main/examples\n[show-and-tell]: https://github.com/eli64s/readme-ai/discussions/categories/show-and-tell\n","funding_links":[],"categories":["CLI tools","CLI","排行榜 [2025-03-18]"],"sub_categories":["Examples","Special-purpose","Other"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feli64s%2FREADME-AI","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feli64s%2FREADME-AI","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feli64s%2FREADME-AI/lists"}