Skip to content

docs: README discovery improvements — opening hook, stars badge, path fix#41

Merged
scotthavird merged 1 commit into
mainfrom
docs/readme-discovery-improvements
Apr 9, 2026
Merged

docs: README discovery improvements — opening hook, stars badge, path fix#41
scotthavird merged 1 commit into
mainfrom
docs/readme-discovery-improvements

Conversation

@scotthavird
Copy link
Copy Markdown
Contributor

@scotthavird scotthavird commented Apr 9, 2026

Summary

Four targeted README fixes identified during a discovery audit. No functional changes — docs only.

Changes

  • Opening line: Replaced the dry feature description with a problem-first hook. Before: "Capture prompts and events from AI coding assistants." After: "Every great workflow you build in Claude Code disappears when the session ends. PromptConduit captures your AI coding sessions and turns repeated patterns into reusable slash commands — automatically, and without a platform account."
  • Stars badge: Added ![GitHub Stars] badge alongside the existing CI/License/Go badges
  • Skills path fix: Line 21 (the "No Account" quick-start block) said ~/.claude/commands/ — corrected to ~/.claude/skills/. The rest of the README already had the right path.
  • set-env clarity: The Switching Environments section previously showed both config set-env and config env use as ambiguous alternatives. Rewritten to show config env use as the primary command and config set-env as the shorthand alias.

Testing

README-only changes. Verified diff looks correct.

Notes

The ~/.claude/skills/ fix was also applied to platform/ (DocsPage.jsx and llms.txt) in a separate PR on that repo.

Closes #42

…fix, set-env clarity

- Rewrite opening line from dry "Capture prompts and events..." to a
  problem-first hook that answers "why would I want this?"
- Add GitHub stars badge alongside existing CI/License/Go badges
- Fix ~/.claude/commands/ → ~/.claude/skills/ (wrong path was on line 21
  in the "No Account" quick-start section; rest of README was already correct)
- Clarify config env switching: show `config env use` as primary command,
  `config set-env` as the shorthand alias — previously both were shown
  ambiguously as alternatives
@scotthavird
Copy link
Copy Markdown
Contributor Author

Conversation Transcripts

Tool Session Gist
Claude Code f7bb42ba-04b9-49b2-a4cc-c230cdca4bf9 View transcript

@scotthavird scotthavird merged commit b988d7b into main Apr 9, 2026
1 check passed
@scotthavird scotthavird deleted the docs/readme-discovery-improvements branch April 9, 2026 16:24
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.

README: improve discovery — problem-first hook, stars badge, correct skills path, set-env clarity

1 participant