Skip to content

Conversation

@RAprogramm
Copy link
Owner

Closes #9

Changes

New Badges

  • Downloads badge: Shows total crates.io downloads
  • Lib.rs badge: Links to lib.rs listing for better discoverability

Badge Reorganization

Badges are now organized into logical groups:

Row 1 - Package Information:

  • Crates.io version
  • Downloads
  • Documentation
  • Lib.rs
  • License

Row 2 - CI & Quality:

  • CI status
  • Code coverage (Codecov)
  • REUSE compliance

Row 3 - Metadata:

  • Rust version requirement
  • Hits-of-Code

Formatting

  • Applied rustfmt to examples for consistency
  • Ensures all CI checks pass

Benefits

  • Better visual organization and readability
  • Show project popularity with download stats
  • Improved discoverability via lib.rs
  • Professional appearance
  • Mobile-friendly badge layout
  • Consistent code formatting

Testing

  • All badge URLs verified and working
  • README renders correctly on GitHub
  • Formatting passes CI checks

- Add crates.io downloads badge
- Add Lib.rs badge
- Reorganize badges into logical groups:
  - Row 1: Package info (version, downloads, docs, lib.rs, license)
  - Row 2: CI/Quality (CI, codecov, REUSE)
  - Row 3: Metadata (Rust version, hits-of-code)
- Apply rustfmt formatting to examples

Benefits:
- Better visual organization
- Show package popularity with downloads
- Lib.rs integration for discoverability
- Professional appearance
- Mobile-friendly layout
@codecov
Copy link

codecov bot commented Oct 19, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

@RAprogramm RAprogramm merged commit c77a535 into main Oct 19, 2025
22 checks passed
@RAprogramm RAprogramm deleted the 9 branch October 19, 2025 01:18
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 crates.io badges and documentation improvements

1 participant