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

Add badge to display install size #594

Closed
wants to merge 1 commit into from
Closed

Conversation

styfle
Copy link

@styfle styfle commented May 22, 2018

This adds a badge to the README.md file to display the npm install size

@coveralls
Copy link

coveralls commented May 22, 2018

Coverage Status

Coverage remained the same at 84.224% when pulling dec45ba on styfle:patch-1 into df41bdb on TypeStrong:master.

@blakeembrey
Copy link
Member

blakeembrey commented May 23, 2018

This doesn't appear relevant and the website is down. If you can state the value of the addition and get the badge hosted alongside the rest (instead of on a down domain), I'll reconsider the PR.

@styfle
Copy link
Author

styfle commented May 23, 2018

Hi @blakeembrey

Sorry for the inconvenience, Package Phobia is getting a lot of traffic now and went down.

The value is to show that ts-node is not a huge implementation of node.js but rather a 2 MB middleman.

These are metrics that are not easily attainable so the badge is nice to show new users who are interested in the project as well as devs can try to achieve a smaller size.

Package Phobia actually caught a bug in TypeScript 5 days ago where the publish size doubled microsoft/TypeScript#23339 (comment)

@blakeembrey
Copy link
Member

Cool, thanks. That seems reasonable and I'd love to accept it, do you think it could be added to https://shields.io/?

@styfle
Copy link
Author

styfle commented May 23, 2018

Thanks! 🎉
I'll need to figure out how to add it to shields.io
I guess I should just make a PR so that shields.io/packagephobia is proxy to my server?

@blakeembrey
Copy link
Member

blakeembrey commented May 23, 2018

I noticed bundlephobia is already on there, it seems like you could use that for reference? I've never really looked into it myself.

Reference: badges/shields#1481

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