search

debug-js / debug

A tiny JavaScript debugging utility modelled after Node.js core's debugging technique. Works in Node.js and web browsers
MIT License
11.12k stars 932 forks source link

remove 22kb readme, use link instead #973

Closed KieranHolroyd closed 1 week ago

KieranHolroyd commented 2 weeks ago

Simple change, makes the unpacked size half of what it currently is while still having a link to the readme, which at 32,659,277 (rounding to 33) means this could save on the order of 0.6TB of internet traffic per week (34.4TB yearly).

Qix- commented 2 weeks ago

Hi, looks nice but I can't find any documentation on this. What is readme-link?

KieranHolroyd commented 2 weeks ago

Sorry, I should have probably explained, it's simply a text file with a link to the readme, it's not any kind of standard, just a file that isn't any variant of actual readme files. This is a highly unimportant PR, but it's also so simple I thought it would be worth doing anyway.

For context I was looking through the expressjs 5.0 release, looking at the changes, found this library and saw the number of weekly downloads, did some napkin maths and made these changes, I'll be honest, I didn't put a great deal of thought into it other than wanting to keep a versioned readme link in the package, while reducing the size

Qix- commented 1 week ago

Ah I see, yeah unfortunately that's not really feasible since the readme must be available on NPM for them to display it.

Thank you though!