diff --git a/packages/size-limit/README.md b/packages/size-limit/README.md index 8a426f42..0fa11eca 100644 --- a/packages/size-limit/README.md +++ b/packages/size-limit/README.md @@ -1,12 +1,32 @@ # Size Limit CLI Tool -Core tool for [Size Limit] to load config and plugins. +Size Limit logo by Anton Lovchikov -See Size Limit docs for more details. +Size Limit is a performance budget tool for JavaScript. It checks every commit +on CI, calculates the real cost of your JS for end-users and throws an error +if the cost exceeds the limit. -[Size Limit]: https://github.com/ai/size-limit/ +* **ES modules** and **tree-shaking** support. +* Add Size Limit to **Travis CI**, **Circle CI**, **GitHub Actions** + or another CI system to know if a pull request adds a massive dependency. +* **Modular** to fit different use cases: big JS applications + that use their own bundler or small npm libraries with many files. +* Can calculate **the time** it would take a browser + to download and **execute** your JS. Time is a much more accurate + and understandable metric compared to the size in bytes. +* Calculations include **all dependencies and polyfills** + used in your JS. - - Sponsored by Evil Martians - +Size Limit CLI + +With **[GitHub action]** Size Limit will post bundle size changes as a comment +in pull request discussion. + +Size Limit comment in pull request about bundle size changes + +See **[full docs](https://github.com/ai/size-limit/)** on GitHub. + +[GitHub action]: https://github.com/andresz1/size-limit-action