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.

Sign up for GitHub

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

Jump to bottom

🚀 Feature: Add npm version badge to README.md (and template) #730

Closed
3 tasks done
JoshuaKGoldberg opened this issue Aug 30, 2023 · 3 comments · Fixed by #880
Closed
3 tasks done

🚀 Feature: Add npm version badge to README.md (and template) #730

JoshuaKGoldberg opened this issue Aug 30, 2023 · 3 comments · Fixed by #880
Labels
good first issue Good for newcomers, please hop on! status: accepting prs Please, send a pull request to resolve this! type: feature New enhancement or request

Comments

@JoshuaKGoldberg
Copy link
Owner

Bug Report Checklist

  • I have tried restarting my IDE and the issue persists.
  • I have pulled the latest main branch of the repository.
  • I have searched for related issues and found none that matched my issue.

Overview

I don't remember why I didn't add a README.md badge that includes the npm version:

https://shields.io/badges/endpoint-badge

<a href="https://npmjs.com/package/create-typescript-app">
  <img alt="npm package version" src="https://img.shields.io/npm/v/create-typescript-app?color=21bb42">
</a>
npm package version

Additional Info

In addition to adding this in the repo's README.md, it'll need to be added to the templating used for setting up other repos. Search files for readme (case insensitive) in their title to see where that's done.
@JoshuaKGoldberg JoshuaKGoldberg added good first issue Good for newcomers, please hop on! type: feature New enhancement or request status: accepting prs Please, send a pull request to resolve this! labels Aug 30, 2023
@rj2704
Copy link

rj2704 commented Sep 1, 2023

Hi @JoshuaKGoldberg, I can fix this issue. You can assign it to me.

@JoshuaKGoldberg
Copy link
Owner Author

@rj2704 I don't use any assignment/claiming processes in this repo - and just realized it's not documented! See #741 (filed just now). Thanks!

@jaas666 jaas666 mentioned this issue Sep 23, 2023
Merged
3 tasks
JoshuaKGoldberg added a commit that referenced this issue Sep 24, 2023
@jaas666 @JoshuaKGoldberg
feat: add npm badge to readme (#880)
e199ea9 
<!-- 👋 Hi, thanks for sending a PR to create-typescript-app! 💖.
Please fill out all fields below and make sure each item is true and [x]
checked.
Otherwise we may not be able to review your PR. -->

## PR Checklist

- [X] Addresses an existing open issue: fixes #730 
- [X] That issue was marked as [`status: accepting
prs`](https://github.com/JoshuaKGoldberg/create-typescript-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
- [X] Steps in
[CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/create-typescript-app/blob/main/.github/CONTRIBUTING.md)
were taken

## Overview

Added npm version badge to readme file. Also added it to the template
that creates the file: `src/steps/writeReadme/generateTopContent.ts`

---------

Co-authored-by: Josh Goldberg <[email protected]>
@github-actions
Copy link

github-actions bot commented Oct 2, 2023

🎉 This is included in version v1.32.0 🎉

The release is available on:

Cheers! 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers, please hop on! status: accepting prs Please, send a pull request to resolve this! type: feature New enhancement or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: add npm badge to readme
2 participants
@JoshuaKGoldberg @rj2704