Skip to content

chore(readme): add CI / Hex / HexDocs badges#2

Merged
fleveque merged 1 commit into
mainfrom
chore/readme-badges
Jun 3, 2026
Merged

chore(readme): add CI / Hex / HexDocs badges#2
fleveque merged 1 commit into
mainfrom
chore/readme-badges

Conversation

@fleveque

@fleveque fleveque commented Jun 3, 2026

Copy link
Copy Markdown
Owner

Summary

Adds the three standard hex-package badges at the top of the README:

  • CI — links to the GitHub Actions workflow and shows current status.
  • Hex.pm — links to the package page and shows the current published version.
  • HexDocs — links to the rendered docs on hexdocs.pm.

Same set Plug, Phoenix, etc. show.

Note on docs

The HexDocs badge will 404 until docs propagate after publish — fixed automatically once the first publish includes docs (which mix hex.publish does). No code change needed.

Test plan

  • Markdown links resolve to the right URLs
  • CI green

Standard hex-package badges so the repo + hex.pm page show build status,
current published version, and a link to docs at a glance.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@fleveque fleveque merged commit a9f574b into main Jun 3, 2026
1 check 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.

1 participant