Skip to content

docs: add project badges to README - #24

Merged
KHolodilin merged 1 commit into
mainfrom
feature/issue-4-add-readme-badges
Jan 24, 2026
Merged

docs: add project badges to README#24
KHolodilin merged 1 commit into
mainfrom
feature/issue-4-add-readme-badges

Conversation

@KHolodilin

Copy link
Copy Markdown
Owner

Description

Add professional project badges to README.md to display project status, version, test coverage, CI status, and other important metrics. This improves project visibility and provides quick access to key project information.

Changes

  • ✅ Added PyPI version badge
  • ✅ Added CI status badge
  • ✅ Added test coverage badge
  • ✅ Added Python version badge
  • ✅ Added license badge
  • ✅ Added stars badge
  • ✅ Added code style badge (Ruff)

Verification

  • All badges are correctly formatted and placed at the beginning of README.md
  • All links point to correct repositories
  • Empty line added after badges for readability
  • Badges are in logical order

Related Issue

Fixes #23

@KHolodilin KHolodilin linked an issue Jan 24, 2026 that may be closed by this pull request
22 tasks
@KHolodilin KHolodilin mentioned this pull request Jan 24, 2026
22 tasks
@codecov-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@KHolodilin
KHolodilin merged commit dabc181 into main Jan 24, 2026
14 checks passed
@KHolodilin
KHolodilin deleted the feature/issue-4-add-readme-badges branch January 25, 2026 17:31
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.

Add project badges to README

2 participants