From 0c20fde75bf08ce996ed0f46ba785045651df0bb Mon Sep 17 00:00:00 2001 From: Yauheni Vasiukevich Date: Fri, 31 Jan 2025 08:26:41 +0000 Subject: [PATCH] docs(loading-time-customization) format doc --- README.md | 6 ++++-- packages/time/README.md | 6 ++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f3cc2108..c0354cb9 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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 diff --git a/packages/time/README.md b/packages/time/README.md index 71bae904..f9b5a092 100644 --- a/packages/time/README.md +++ b/packages/time/README.md @@ -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: