📝 docs(readme): clarify badge examples to avoid confusion

[marmarmo]

This PR updates the README to clarify that the Markdown and HTML badge snippets are intended as usage examples and not broken or un-rendered badges.

NOTE: While editing, I ran the project's formatting/linting commands as instructed (bun format), which resulted in additional formatting changes within the README.md — mainly minor whitespace and structure updates.

These changes were auto-generated, not made manually. If needed, I’m happy to separate them into a new PR.

✅ Docs-only change in README.md
✅ Follows GitBook's contribution guide
✅ Resolves #3244

[changeset-bot]

⚠️ No Changeset found

Latest commit: 07c7db0

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[marmarmo]

Hi! @addisonschultz

Just flagging that the CI failures seem unrelated to my changes — this PR only touches README.md, and everything passed before main was merged in.

It looks like the failures are due to missing environment variables or secret tokens in the CI setup (e.g. Vercel, Cloudflare, 1Password integrations).

Happy to help or adjust anything on my end if needed, just let me know.

[addisonschultz]

Hi @marmarmo - thanks so much for contributing this. I’m looking into the issues with the CI pipeline - there’s something wrong at the moment.

Additionally, I’d like to fix our formatter (I’m updating our contributing guide as well with some other things you’ve pointed as well - thank you!)

Would you mind reverting the changes from the formatter? And only adding the changes for adding the clarification between the badge code snippets? It’s a good addition and I’m happy to add it as it’s helping some of our users with the distinction as well.

Appreciate your contributions so far!

[marmarmo]

hey @addisonschultz. I’ve reverted all the formatter/style changes — thanks so much for the feedback 🙌

The only lingering issue now is the Font Awesome Pro icon error in CI. Based on the README, it looks like this is something only GitBook staff can resolve.

Then I think this should be good to go! If not, let me know if theres anything else you need from me.