Skip to content

Commit

Permalink
docs(loading-time-customization) format doc
Browse files Browse the repository at this point in the history
  • Loading branch information
EvgenyWas committed Jan 31, 2025
1 parent 12c4cb5 commit 0c20fde
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ if the cost exceeds the limit.
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. Additionally, you can [customize time plugin] via config for every check with network speed, latency and so on.
and understandable metric compared to the size in bytes.
Additionally, you can [customize time plugin] via config
for every check with network speed, latency and so on.
* Calculations include **all dependencies and polyfills**
used in your JS.

Expand Down Expand Up @@ -50,7 +52,7 @@ We are using [Statoscope] for this analysis.
[Statoscope]: https://github.com/statoscope/statoscope
[cult-img]: http://cultofmartians.com/assets/badges/badge.svg
[cult]: http://cultofmartians.com/tasks/size-limit-config.html
[customize time plugin]: https://github.com/ai/size-limit/packages/time#custom-options
[customize time plugin]: https://github.com/ai/size-limit/packages/time#customize-network-speed

## Who Uses Size Limit

Expand Down
6 changes: 4 additions & 2 deletions packages/time/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,11 @@
The plugin for [Size Limit] to track JS download and execution time by [estimo]
and Puppeter.

## Custom options
## Customize Network Speed

By default, Size Limit measures the loading time of your files using a slow 3G network (50 kB/s) without latency. You can customize these settings for each check by modifying your Size Limit configuration:
By default, Size Limit measures the loading time of your files using a slow 3G
network (50 kB/s) without latency. You can customize these settings for each
check by modifying your Size Limit configuration:

1. Install the preset:

Expand Down

0 comments on commit 0c20fde

Please sign in to comment.