Skip to content

README: lead with agent value + consolidated feature overview#9

Merged
jlevy merged 4 commits into
masterfrom
claude/readme-tip-front
May 23, 2026
Merged

README: lead with agent value + consolidated feature overview#9
jlevy merged 4 commits into
masterfrom
claude/readme-tip-front

Conversation

@jlevy

@jlevy jlevy commented May 23, 2026

Copy link
Copy Markdown
Owner

Summary

Doc-only README restructure to put the value-for-coding-agents framing first and give a single concise overview of the whole library.

  • Moved the highlight tip block (NEW v3.1 banner + prettyfmt callout) to the top, right after the intro.
  • Replaced the separate "Using strif with LLM Agents" + "Key Features" sections with one consolidated "Why Use strif (Especially with Coding Agents)" section, placed before everything else. It leads with the agent value and a ready-to-paste prompt, then lists every capability (atomic files, base36/timestamped ids, hashing, AtomicVar, string utils, quoting) so an agent can understand the full library in one read.
  • Dropped the human-oriented code example (the section is aimed at agent enablement, not tutorial code).

No code changes.

Test plan

  • codespell clean on README
  • CI green (doc-only)

https://claude.ai/code/session_01Td1N9waEtmcArZh5jNBdLH

claude added 2 commits May 23, 2026 20:12
Combine the "NEW in 3.1" banner with the prettyfmt callout into a single
[!TIP] block placed right after the intro, and remove the now-duplicate
prettyfmt tip that was below Key Features.
Merge the agent-usage framing and the Key Features list into a single
"Why Use strif (Especially with Coding Agents)" section placed before
everything else. Leads with the value for coding agents and a ready-to-paste
prompt, then gives a concise complete overview of every capability (atomic
files, base36/timestamped ids, hashing, AtomicVar, string utils, quoting)
so an agent can understand the whole library in one read. Dropped the
human-oriented code example.
@jlevy jlevy changed the title README: move highlight tip block to the top README: lead with agent value + consolidated feature overview May 23, 2026
@jlevy jlevy marked this pull request as ready for review May 23, 2026 20:20
@jlevy jlevy merged commit f66ba7e into master May 23, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants