Skip to content

Conversation

jaseemjaskp
Copy link
Contributor

Summary

This PR adds a version badge to the README.md file to display the current client version (v0.1.1) alongside the other project badges.

Changes

  • Added version badge displaying current client version (0.1.1)
  • Badge links to the PyPI package page for easy access to package information
  • Positioned the badge after the Python version badge for logical grouping and better visual flow

Motivation

Having a version badge in the README provides:

  • Immediate visibility of the current package version
  • Quick access to the PyPI package page
  • Better project documentation and transparency
  • Consistency with common open-source project practices

Related Issues

N/A - This is a documentation enhancement.

Testing

  • ✅ All pre-commit hooks passed (prettier for markdown formatting)
  • ✅ Badge renders correctly in markdown
  • ✅ Link to PyPI package page is functional
  • ✅ No functional changes - only documentation update

Checklist

  • Documentation follows project standards
  • Badge URL and version are accurate
  • Badge placement is logical and visually appealing
  • No breaking changes introduced
  • Self-review completed

- Add client version badge (v0.1.1) to README.md badge section
- Badge links to PyPI package page for easy access
- Positioned after Python version badge for logical grouping
- Replace hardcoded version badge with shields.io PyPI version badge
- Badge now automatically pulls latest version from PyPI
- No manual updates needed when releasing new versions
- Maintains same functionality with better maintainability
Copy link
Contributor

🧪 Test Report

Test Results

Test Environment

  • Python Version: 3.12
  • OS: Ubuntu Latest
  • Tox Environment: py312

Status

✅ All tests passed successfully!

@jaseemjaskp jaseemjaskp merged commit 877986c into main Jul 25, 2025
3 checks passed
@jaseemjaskp jaseemjaskp deleted the feature/add-version-badge branch July 25, 2025 12: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.

1 participant