README Summarizer

WHAT IT DOES

AI-powered README summarizer that creates concise, structured project overviews from README files. The script reads README.md content from the current page—project name, description, installation, usage, features, configuration, contributing, and license—and generates a clear, structured summary of what the project does, who it's for, and key details for quick understanding. The AI produces a concise overview covering the project's purpose, main features, installation steps, and usage basics. You can customize the summary length and toggle inclusion of installation, usage, features, and prerequisites. The user reviews the output before copying or using it.

WHERE IT RUNS

Works on GitHub README pages (match pattern *://github.com/*/*/blob/*/README.md), including public and private repositories, GitHub Enterprise instances, and any GitHub repository README file. The script activates specifically on README pages to provide focused summarization.

HOW TO USE

Install the script and navigate to any GitHub repository README page. The README Summarizer appears in the panel. Configure your preferred summary length and toggle inclusion of installation, usage, features, and prerequisites using the settings controls. Click "Summarize" to analyze the current README. The AI extracts README content and generates a clear project overview. Review the output in the panel. Click "Copy to Clipboard" to copy the summary for sharing, documentation, or quick reference. Adjust the settings and regenerate if you want a different level of detail.

REAL MECHANISM: DOM CONTENT EXTRACTION WITH AI README SUMMARIZATION AND REVIEW GATE

This script uses a hybrid extraction approach that prioritizes structured content when available. First, it checks for WebMCP (navigator.modelContext), a W3C proposal that exposes structured tools on the page. If available, it calls getContent() to obtain structured README data. If WebMCP is not present—the common case today—it falls back to DOM scraping using targeted selectors for GitHub README content (.markdown-body, .readme, .README, [data-testid*="readme"], .Box-body .markdown-body). The extracted text is sent to an AI backend via GM_xmlhttpRequest, which processes it with a system prompt that includes the user's summary length and inclusion preferences. The AI returns a concise summary (100-200 words depending on the selected length) covering the project's purpose, main features, installation steps, and usage basics. The response is displayed in a bordered container for review before copying. Copy-to-clipboard uses GM_setClipboard. All settings (summaryLength, includeInstallation, includeUsage, includeFeatures, includePrerequisites) are persisted via GM_setValue. The script enforces a review-before-use pattern: the user must read and approve the AI output before copying it.

THE PANEL

Drag the panel anywhere on screen by clicking and holding the header. It snaps to screen edges when released. Collapse it to a small bubble by clicking the minimize button, and expand it back by clicking the bubble. Resize the panel from any corner. Press Escape to close the configuration panel. Your position and size preferences are saved automatically per site.

PLEASE NOTE

This script requires the free BotGentz browser extension and an active AI subscription for the summarization service. AI-generated summaries should be reviewed for accuracy before use—the AI may misinterpret README content or omit important details. The script reads the current page content and sends it to the AI backend for processing; no data is stored or logged. The script targets GitHub README pages specifically and will only activate on valid README URLs.