docs: add badges to README

[justin808]

Summary

• Add MIT license badge
• Add Gem version badge from badge.fury.io
• Add Ruby CI workflow badge from GitHub Actions

Makes the README more professional and consistent with other ShakaCode projects like react_on_rails and shakapacker.

Test plan

• Verify badges display correctly on GitHub
• Confirm all badge links work properly
• Check that badge styling is consistent

🤖 Generated with Claude Code

Summary by CodeRabbit

• Documentation
  • Added informational badges to documentation, including License, Gem Version, and CI workflow status indicators.

[coderabbitai]

Walkthrough

Added three badges (License, Gem Version, Ruby workflow) to the top of README.md. These badges provide visual status indicators for the project without modifying any functional content or documentation structure.

Changes

Cohort / File(s)	Summary
README badges README.md	Added License, Gem Version, and Ruby workflow status badges at the top of the file

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

• The change is purely cosmetic, adding standard project badges with no logic or documentation alterations

Poem

🐰 A splash of badges, shiny and bright,
Tells the world that our project's just right!
License and version, all on display,
Little ribbons of status brighten the day! ✨

Pre-merge checks and finishing touches

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The PR title "docs: add badges to README" directly and accurately reflects the main change in the pull request. According to the summary, the changeset adds three badges (License, Gem Version, and Ruby workflow) to the top of the README.md file, which is purely a presentational enhancement. The title is concise, uses clear language with the conventional "docs:" prefix to indicate a documentation change, and specifically identifies both the action (add badges) and the target (README). A teammate reviewing the commit history would immediately understand that this PR adds badges to the README documentation.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch justin808/add-readme-badges

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0e26f49 and 5130cc8.

📒 Files selected for processing (1)

• README.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (10)

• GitHub Check: test (macos-latest, head)
• GitHub Check: test (ubuntu-latest, 3.1)
• GitHub Check: test (ubuntu-latest, head)
• GitHub Check: test (windows-latest, head)
• GitHub Check: test (macos-latest, 2.6)
• GitHub Check: test (windows-latest, 3.1)
• GitHub Check: test (windows-latest, 3.0)
• GitHub Check: test (macos-latest, 2.7)
• GitHub Check: test (ubuntu-latest, 2.6)
• GitHub Check: test (ubuntu-latest, 2.7)

🔇 Additional comments (1)

README.md (1)

3-6: Excellent addition to improve project professionalism.

The three badges are well-chosen and align with the PR objectives. The License, Gem Version, and CI workflow badges provide clear, at-a-glance status indicators. The placement at the top of the README before the main description follows standard conventions used in quality open-source projects (as noted in the PR description comparing to react_on_rails and shakapacker).

[coderabbitai]

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

Verify badge target files exist before merging.

The badges reference LICENSE.md and the GitHub Actions workflow checks.yml. Please confirm these files exist in the repository, as broken badge links would negatively impact the README's professional appearance.

---

🏁 Script executed:

#!/bin/bash
# Verify that LICENSE.md and the GitHub Actions workflow file exist

echo "=== Checking LICENSE.md ==="
if [ -f "LICENSE.md" ]; then
  echo "✓ LICENSE.md found"
else
  echo "✗ LICENSE.md NOT found"
fi

echo ""
echo "=== Checking GitHub Actions workflow ==="
if [ -f ".github/workflows/checks.yml" ]; then
  echo "✓ .github/workflows/checks.yml found"
else
  echo "✗ .github/workflows/checks.yml NOT found"
  # Check for any existing workflows
  echo "Existing workflows:"
  find .github/workflows -type f 2>/dev/null | head -5 || echo "  (no workflows directory)"
fi

Length of output: 129

---

---

🏁 Script executed:

```shell
#!/bin/bash
# Check for any LICENSE files in the repository root

echo "=== Searching for LICENSE files in repository root ==="
find . -maxdepth 1 -iname "LICENSE*" -type f 2>/dev/null | sort

echo ""
echo "=== Checking common license file names ==="
for file in LICENSE LICENSE.md LICENSE.txt LICENSE.rst COPYING COPYING.md LICENCE LICENCE.md; do
  if [ -f "$file" ]; then
    echo "✓ Found: $file"
  fi
done

Length of output: 133

---

Fix broken LICENSE badge link: change LICENSE.md to LICENSE.txt on line 3.

The LICENSE badge references LICENSE.md, but the repository contains LICENSE.txt. Update the badge URL to reference the correct file to prevent a broken link.

🤖 Prompt for AI Agents

In README.md around lines 3 to 5, the license badge link points to LICENSE.md
which does not exist in the repo; update the badge URL to reference LICENSE.txt
instead so the badge links to the correct file.