Skip to content

Align Ink README badge block with custom-fields#14

Merged
ManukMinasyan merged 1 commit into
mainfrom
copilot/check-readme-and-badges
May 19, 2026
Merged

Align Ink README badge block with custom-fields#14
ManukMinasyan merged 1 commit into
mainfrom
copilot/check-readme-and-badges

Conversation

Copilot AI commented May 19, 2026

Copy link
Copy Markdown
Contributor

ink README did not mirror the badge presentation used in custom-fields, making package metadata less immediately scannable at the top of the page. This update aligns the badge block format and coverage between the two repos.

  • Header badge parity

    • Added a top-of-README badge row in README.md using the same for-the-badge visual style as custom-fields.
    • Included badges for:
      • Packagist downloads (relaticle/ink)
      • Laravel support (12.x | 13.x)
      • PHP requirement (8.4)
      • License (MIT)
      • CI test workflow status (tests.yml, main)
  • Scope

    • README-only documentation change; no package/runtime behavior changes.
<a href="https://packagist.org/packages/relaticle/ink">
  <img src="https://img.shields.io/packagist/dt/relaticle/ink.svg?style=for-the-badge" alt="Downloads">
</a>
<a href="https://github.com/relaticle/ink/actions/workflows/tests.yml">
  <img src="https://img.shields.io/github/actions/workflow/status/relaticle/ink/tests.yml?branch=main&style=for-the-badge&label=tests" alt="Tests">
</a>

Agent-Logs-Url: https://github.com/relaticle/ink/sessions/b0997a3a-23e7-4fb8-872e-9ffe5ae41a0d

Co-authored-by: ManukMinasyan <2556185+ManukMinasyan@users.noreply.github.com>
@ManukMinasyan ManukMinasyan marked this pull request as ready for review May 19, 2026 19:06
Copilot AI review requested due to automatic review settings May 19, 2026 19:06
@ManukMinasyan ManukMinasyan merged commit 2030a77 into main May 19, 2026
2 checks passed

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Aligns the ink README’s top-of-page badge block with the format used in custom-fields, improving quick scannability of package metadata.

Changes:

  • Added a top-of-README badge row using Shields.io for-the-badge style.
  • Included badges for downloads, Laravel support versions, PHP requirement, license, and CI tests workflow status.
Comments suppressed due to low confidence (1)

README.md:7

  • In HTML attribute values, & should be escaped as &amp; to avoid invalid HTML and potential rendering issues. Update the img URL query string separators accordingly (e.g., ...branch=main&amp;style=for-the-badge&amp;label=tests).
  <a href="https://github.com/relaticle/ink/actions/workflows/tests.yml"><img src="https://img.shields.io/github/actions/workflow/status/relaticle/ink/tests.yml?branch=main&style=for-the-badge&label=tests" alt="Tests"></a>

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
Comment on lines +4 to +7
<a href="https://laravel.com/docs/12.x"><img src="https://img.shields.io/badge/Laravel-12.x%20%7C%2013.x-FF2D20?style=for-the-badge&logo=laravel" alt="Laravel 12 and 13"></a>
<a href="https://php.net"><img src="https://img.shields.io/badge/PHP-8.4-777BB4?style=for-the-badge&logo=php" alt="PHP 8.4"></a>
<a href="https://packagist.org/packages/relaticle/ink"><img src="https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge" alt="License"></a>
<a href="https://github.com/relaticle/ink/actions/workflows/tests.yml"><img src="https://img.shields.io/github/actions/workflow/status/relaticle/ink/tests.yml?branch=main&style=for-the-badge&label=tests" alt="Tests"></a>
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.

3 participants