Skip to content

docs: add badges and formatting to readme #2534

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 20, 2024
Merged

Conversation

castastrophe
Copy link
Collaborator

@castastrophe castastrophe commented Feb 16, 2024

Description

Add build status badges to our package README and revamp and clarify our introductory documentation.

Preview

To-do list

  • I have read the contribution guidelines.
  • If my change impacts documentation, I have updated the documentation accordingly.
  • ✨ This pull request is ready to merge. ✨

Copy link
Contributor

github-actions bot commented Feb 16, 2024

🚀 Deployed on https://pr-2534--spectrum-css.netlify.app

Copy link
Contributor

github-actions bot commented Feb 16, 2024

File metrics

Summary

Total size: 3.93 MB*

🎉 No changes detected in any packages

* Size determined by adding together the size of the main file for all packages in the library.
* Results are not gzipped or minified.
* An ASCII character in UTF-8 is 8 bits or 1 byte.

@castastrophe castastrophe changed the title docs badges readme docs: add badges and formatting to readme Feb 16, 2024
Copy link
Collaborator

@jawinn jawinn left a comment

Choose a reason for hiding this comment

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

Nice work! These are some great much-needed improvements across the board, and to the start of the document. Love the added visuals and badges.

Just one issue I saw with the links, and something got out of alignment in the rebase.

@castastrophe castastrophe merged commit 5524456 into main Feb 20, 2024
@castastrophe castastrophe deleted the docs-badges-readme branch February 20, 2024 15:49
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