docs(readme): front-load search keywords in hook for GitHub discoverability#47
Merged
docs(readme): front-load search keywords in hook for GitHub discoverability#47
Conversation
…bility
GitHub search excerpts the top of the README in result listings. The
current opening is a single thin line ("Python client for the Cycles
budget-management protocol") that does not match what a Python developer
searching GitHub for "AI agent budget Python", "LangChain cost control",
"CrewAI governance", or "OpenAI Agents SDK budget" would actually type.
Rewrites the H1 + opening into a keyword-rich two-paragraph summary that
names the framework integration surface (OpenAI, Anthropic, LangChain,
OpenAI Agents SDK, CrewAI). No structural changes below line 9.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Rewrites the H1 + opening of
README.mdso the GitHub search excerpt names the Python framework surface (OpenAI, Anthropic, LangChain, OpenAI Agents SDK, CrewAI).Before (line 7):
# Cycles Python ClientAfter:
# Cycles Python Client — AI agent budget and action authority SDKThe single thin line becomes a 2-paragraph keyword-rich summary plus an inline
pip installmention. No structural changes below line 9.Why
GitHub repo search ranks and excerpts on the top of the README. A Python developer searching for "AI agent budget Python", "LangChain cost control", "CrewAI governance", or "OpenAI Agents SDK budget" would not match the previous opening on those phrases.
Scope
README.mdPart of an SEO/discoverability pass across the runcycles org. Sibling PRs: cycles-protocol#78, cycles-server#140, cycles-server-admin#157, cycles-spring-boot-starter#51.