Skip to content

Fix README header to match sfx org template structure - #24

Merged
joeblau merged 3 commits into
mainfrom
cursor/fix-readme-header-2078
Oct 18, 2026
Merged

joeblau merged 3 commits into
mainfrom
cursor/fix-readme-header-2078

Conversation

@joeblau

@joeblau joeblau commented Oct 12, 2026

Copy link
Copy Markdown
Contributor

Changes

This PR fixes the README header to match the exact structure used in bloxwap/sfx, the org template reference.

Header Structure

The header now follows the sfx pattern exactly:

  1. Centered <h1> title
  2. HTML comment horizontal rule
  3. Centered two-line tagline paragraph ending with "Try the live demo" link
  4. HTML comment horizontal rule
  5. Centered row of four badges (npm version, downloads, coverage, minzipped size)

Key Changes

  • Centered HTML elements instead of plain markdown
  • Horizontal rules using HTML comments with dash lines (matching sfx)
  • Two-line tagline with line break: "Haptic feedback for React on iOS and vibration-capable browsers." / "SSR-safe, with graceful fallbacks. Try the live demo."
  • Badge style changed from flat-square to default flat (matching sfx)
  • Badge order matches sfx: npm version, downloads/month, coverage, minzipped size
  • Single badge row in centered paragraph (no extra rows or badges)

Diff Verification

The header structure is now identical to sfx's, with only the package name, tagline text, and URLs adapted for haptic.

CI Status

Waiting for CI to complete.

Open in Web Open in Cursor 

@joeblau
joeblau merged commit 18c025c into main Oct 18, 2026
5 checks passed
@joeblau
joeblau deleted the cursor/fix-readme-header-2078 branch October 18, 2026 16: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.

2 participants