Documentation·Pushed May 9, 2026·M
README rewritten with clearer pitch and agent prompts
Gitpulse's README got a complete rewrite. The new version leads with a stronger tagline, adds a feature grid for quick scanning, explains how the tool works, and — crucially — includes copyable prompts for AI coding agents at each deployment step.
The README was rewritten to better communicate what Gitpulse does and how to set it up. A new tagline ("Let your code contributions speak for themselves") and feature grid make the value proposition immediately clear. A "How it works" section breaks down the two-piece architecture — CLI and static deploy — in plain terms.
Perhaps the most practical addition: copyable coding agent prompts for every deployment target. Each collapsible section (GitHub Pages, Vercel, Netlify, Cloudflare Pages, custom S3) now includes a ready-to-paste prompt that tells an AI agent exactly what to do, including links to the configuration schema and workflow files. Developers handing off setup to an AI assistant can copy the right block and go.
The changes live entirely in [[code]]README.md[[/code]].
Technical description
This commit is a pure documentation update to [[code]]README.md[[/code]]. No code was changed.
**What changed:**
The README was restructured from the ground up. The old intro ("[[code]]git log[[/code]] was never meant for humans") was retained but expanded with a stronger tagline and centered layout. A feature grid was added using a plain HTML table — four cells covering AI-generated stories, zero infrastructure, deploy anywhere, and any LLM provider, with password protection spanning the full width.
A new "How it works" section explains the two-piece architecture: [[code]]@gitpulse/cli[[/code]] runs two subcommands ([[code]]analyze[[/code]] and [[code]]build[[/code]]), and a static deploy receives the output. State management is described as the deployed site itself, with each run fetching [[code]]manifest.json[[/code]] to resume incrementally.
The Quickstart section was expanded with GitHub-style callout blocks using [[code]]> [!NOTE][[/code]] syntax for important pre-1.0 warnings. Most notably, every deployment target section (GitHub Pages, Vercel, Vercel via GitHub Actions, Netlify, Cloudflare Pages, and custom S3) now contains a collapsible [[code]]<blockquote><details>[[/code]] block with a copyable coding agent prompt. Each prompt follows the same pattern: task description, "Read these before implementing" with relevant links, and instructions to ask about options before implementing.
The overall effect is a README that sells the product harder and makes agent-driven setup practical.
**Files at a Glance:**
- [[code]]README.md[[/code]] — complete rewrite with new structure, feature grid, how-it-works section, and copyable coding agent prompts