Skip to content
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

docs: update badges #35

Merged
merged 1 commit into from
Jul 13, 2023
Merged

docs: update badges #35

merged 1 commit into from
Jul 13, 2023

Conversation

agilgur5
Copy link
Owner

Summary

Update badges a tiny bit to be more consistent with what I use today

Details

  • remove old nodei.co badge

    • doesn't always load and isn't very useful anymore
    • removing it from all of my NPM projects
  • simplify typings badge to use a relative link

    • no need to specify branch name or full repo name
  • also change Installation to a codeblock instead of just backticks

    • easier to read as a block and easier to copy (full horizontal length)
    • and more consistent too

- remove old `nodei.co` badge
  - doesn't always load and isn't very useful anymore
  - removing it from all of my NPM projects

- simplify typings badge to use a relative link
  - no need to specify branch name or full repo name

- also change Installation to a codeblock instead of just backticks
  - easier to read as a block and easier to copy (full horizontal length)
  - and more consistent too
@codecov

This comment was marked as resolved.

@agilgur5 agilgur5 merged commit 813f717 into main Jul 13, 2023
8 checks passed
@agilgur5 agilgur5 deleted the docs-badges branch July 13, 2023 02:47
Copy link
Owner Author

@agilgur5 agilgur5 left a comment

Choose a reason for hiding this comment

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

simpler 🙂

also GH adds a copy button to code blocks as a nice touch!

@agilgur5 agilgur5 added the scope: docs Documentation could be improved label Jul 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope: docs Documentation could be improved
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant