search

lukeed / polka

A micro web server so fast, it'll make you dance! :dancers:
MIT License
5.43k stars 174 forks source link

Make polka ultra light weight #127

Open ASaiAnudeep opened 4 years ago

ASaiAnudeep commented 4 years ago

When polka package is published to npm, it includes the readme file which weights around 22 kB.

https://github.com/lukeed/polka/blob/master/packages/polka/readme.md

Moving this documentation to GitHub Wiki or some other place would reduce the unpacked size from 25.5 kB to 4.31 kB.

Update readme to include minimal details & add external references to the much more detailed documentation.

Thanks for this awesome package.

leeoniya commented 4 years ago

does npm still pull the readme from the linked repo if one is not in the package? i personally find it convenient to read the docs directly on npm when browsing/evaluating libs - saves a lot of clicks.

lukeed commented 4 years ago

Hey there,

Thanks for the suggestion and kind words. I've definitely wanted to do this in the past to help highlight how small it truly is, but I'm also like @leeoniya and look at readmes thru npm very often.

My game plan is to finish up a docs site for Polka 1.0 and link to that within the readme. That way it's a better set of docs (instead of the current massive wall of text) and it's only one click to get there. A readme would still exist but it'd be very little.

What do you think?

lukeed commented 4 years ago

This would also be the case for Polkadot

ASaiAnudeep commented 4 years ago

That would be great!