Skip to content

docs: add badges to README#118

Merged
CybotTM merged 2 commits intomasterfrom
feature/add-readme-badges
Sep 29, 2025
Merged

docs: add badges to README#118
CybotTM merged 2 commits intomasterfrom
feature/add-readme-badges

Conversation

@CybotTM
Copy link
Copy Markdown
Member

@CybotTM CybotTM commented Sep 29, 2025

Summary

Add standard badges to README following the same pattern as netresearch/simple-ldap-go

Badges Added

  • Go Reference - Links to pkg.go.dev documentation
  • Go Report Card - Code quality metrics
  • Docker Build - GitHub Actions workflow status
  • Go Version - Current Go version from go.mod
  • License: MIT - Project license
  • Latest Release - GitHub releases
  • Maintenance - Active maintenance status
  • PRs Welcome - Contribution encouragement

Preview

The badges will appear at the top of the README, providing quick visibility into:

  • Project status and quality
  • Build health
  • Current version and license
  • Contribution guidelines

All badges use standard shields.io and GitHub formats for consistency.

Add standard badges for Go project:
- Go Reference (pkg.go.dev)
- Go Report Card
- Docker Build status
- Go Version
- License (MIT)
- Latest Release
- Maintenance status
- PRs Welcome

Badges follow same pattern as netresearch/simple-ldap-go
@CybotTM CybotTM merged commit 267414c into master Sep 29, 2025
3 checks passed
@CybotTM CybotTM deleted the feature/add-readme-badges branch September 29, 2025 21:30
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