Skip to content

Conversation

agilgur5
Copy link
Owner

Summary

Fix badges and update a tiny bit to be more consistent with what I use today

Details

  • update/fix "build status" badge according to Shields directions: Change to GitHub workflow badge routes badges/shields#8671

  • remove old nodei.co badge

    • doesn't always load and isn't very useful anymore
    • removing it from all of my NPM projects
  • 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

- update/fix "build status" badge according to Shields directions

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

- 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.

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.

render LGTM. all tests pass

@agilgur5 agilgur5 merged commit cb09cf7 into main Jul 13, 2023
@agilgur5 agilgur5 deleted the docs-update-badges branch July 13, 2023 03:01
@agilgur5 agilgur5 added scope: docs Documentation could be improved version: patch Upgrade patch version when merged labels Jul 13, 2023
agilgur5 added a commit that referenced this pull request Jan 3, 2025
- update/fix "build status" badge according to Shields directions

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

- 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

(cherry picked from commit cb09cf7)
- removed typings badge (v1.0.x isn't in TS)
- changed badge branches to point to `v1.0.x`
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 version: patch Upgrade patch version when merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant