Skip to content

Commit

Permalink
Improve size-limit npm package docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ai committed Oct 12, 2021
1 parent e391df0 commit 677df74
Showing 1 changed file with 27 additions and 7 deletions.
34 changes: 27 additions & 7 deletions packages/size-limit/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,32 @@
# Size Limit CLI Tool

Core tool for [Size Limit] to load config and plugins.
<img src="https://ai.github.io/size-limit/logo.svg" align="right"
alt="Size Limit logo by Anton Lovchikov" width="120" height="178">

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.

<a href="https://evilmartians.com/?utm_source=size-limit">
<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg"
alt="Sponsored by Evil Martians" width="236" height="54">
</a>
<img src="./img/example.png" alt="Size Limit CLI" width="738">

With **[GitHub action]** Size Limit will post bundle size changes as a comment
in pull request discussion.

<img src="https://raw.githubusercontent.com/andresz1/size-limit-action/master/assets/pr.png"
alt="Size Limit comment in pull request about bundle size changes"
width="686" height="289">

See **[full docs](https://github.com/ai/size-limit/)** on GitHub.

[GitHub action]: https://github.com/andresz1/size-limit-action

0 comments on commit 677df74

Please sign in to comment.