docs(readme): overhaul with logo, community, security, and integrations#267
Merged
Merged
Conversation
The README had grown stale relative to the project's current state. This brings it up to par with comparable open-source credential tools (Doppler, Infisical) and agent infra READMEs (Ollama, Continue). Tier 1 (correctness): - Fix Tests + codecov badge URLs from manojbajaj95 to agentrhq. - Drop broken link to docs/specs/authsome-v1.md (removed upstream). - Replace 3 em-dashes with periods per house style. - Repoint Docs section links to hosted authsome.agentr.dev/docs instead of local MDX paths (better reading experience on GitHub). Tier 2 (close gaps every comparable project has): - Add Install section before Quick Start with pip and uvx commands. - Add Community section linking Discord and Issues. - Add Security section pointing at the responsible disclosure policy. Critical for a credential tool; was previously absent. - Add Contributing section linking to CONTRIBUTING.md. Tier 3 (polish and differentiation): - Add light/dark wordmark logo at top (reuses the SVG mark shipped to the docs site, sized for README hero). - Add header link bar (Docs / Website / Discord / Issues). - Surface "44 bundled providers" callout near the top. - Add Agent Integrations section listing Claude Code, Codex, Cursor, OpenCode, LangChain, LlamaIndex, OpenAI Agents SDK, Anthropic SDK. - Add Discord badge to the badge row. - Replace the ASCII art block with the logo image. The ASCII was a placeholder before a real brand mark existed.
Adds the codecov badge to the badge row alongside the existing Tests badge so the coverage signal sits next to the build signal. Adds a Star History chart between Contributing and License using the star-history.com embed, with light/dark variants via <picture>. The codecov badge depends on the codecov integration being wired up for agentrhq/authsome; if it isn't yet, the badge will render as "unknown" until the integration is enabled.
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
2 participants
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.
Summary
Brings the README up to par with comparable open-source credential tools (Doppler, Infisical) and agent infra READMEs (Ollama, Continue) after a survey of five reference projects. Three tiers of change:
Tier 1 · correctness fixes
manojbajaj95/authsome(stale fork) toagentrhq/authsome.docs/specs/authsome-v1.md(removed upstream in a recent merge)..mdxpaths.Tier 2 · close gaps every comparable project has
pip install authsomeanduvx authsome@latestbefore Quick Start.Tier 3 · polish and differentiation
Test plan