Documentation·Pushed May 9, 2026·M
README gets visual refresh and clearer structure
Gitpulse's README gets a clean-up pass: better visual markers on feature headers, a collapsible intro section, and agent setup instructions moved to where developers actually need them.
The README was rewritten to be easier to scan. Feature headers across the top row now carry ◆ markers for visual contrast. The "How it works" section condenses into a one-liner with an expandable "More details" toggle — giving newcomers the short version upfront while keeping the full technical explanation available. The Pre-1.0 warning is removed, reflecting that the project is now further along. Agent setup instructions are repositioned to the top of each deployment section (GitHub Pages, Vercel, Netlify, Cloudflare Pages), so developers handing instructions to a coding agent get the copyable prompt immediately rather than buried at the bottom.
Technical description
This is a documentation-only change to [[code]]README.md[[/code]]. Five distinct improvements were made:
**Feature header markers.** Five feature items in the top grid — AI-generated stories, Zero infrastructure, Deploy anywhere, Any LLM provider, and Optional password protection — each received a ◆ prefix. This creates visual separation between headers and the descriptive text that follows.
**Tagline update.** The opening tagline shifted from "The easiest automated way" to "The easy and 100% automated way" — a minor tonal change that reads more directly.
**"How it works" collapse.** The architecture explanation, previously always visible, now shows only a one-sentence summary: "A CLI (gitpulse analyze + gitpulse build) runs in your CI, reads your git history, and publishes a static site. No external service, no database, nothing outside your pipeline." The full explanation sits in an expandable details block below.
**Pre-1.0 note removal.** The callout warning consumers to pin @0 / @v0 versions was deleted from the Quickstart section.
**Agent instructions repositioned.** Each deployment target (GitHub Pages, Vercel x2, Netlify, Cloudflare Pages) now shows the copyable agent prompt as the first item inside the collapsible section, before the YAML or TOML configuration examples.
Files at a Glance:
- [[code]]README.md[[/code]] — documentation polish: markers, collapsed section, removed warning, repositioned agent prompts
Categories
- Documentation (85%) — This commit is entirely focused on improving README.md - visual structure, readability, and information architecture. No code functionality changes.
- Code Style (15%) — Added ◆ markers for visual contrast, collapsed sections with toggles, reformatted agent instructions - pure presentation improvements with no functional impact.