matthewp / haunted

React's Hooks API implemented for web components 👻
BSD 2-Clause "Simplified" License
2.62k stars 92 forks source link

Show bundled file size in readme #95

Open stevenvachon opened 5 years ago

stevenvachon commented 5 years ago

It's important, I think, if the goal is to communicate that this can replace React in more ways than function.

matthewp commented 5 years ago

Yep, good point. I think there's some badges out there that automate this sort of thing too.

stevenvachon commented 5 years ago

My experience with those automated badges is that they show the package size and not the bundled size. Because of this, I manually update a custom badge's text (via a URL within the readme) for my personal projects.

matthewp commented 5 years ago

@stevenvachon Thanks! Do you have an example where you do this?

stevenvachon commented 5 years ago

@matthewp the readme for https://github.com/stevenvachon/scrolling-menu

The gzipped bundle size is calculated on each build, making readme updates quick.