From 2ca0eae5fd5cf04e6030ad9766264ad3b23b3757 Mon Sep 17 00:00:00 2001 From: Vio Date: Sat, 9 Oct 2021 11:45:03 +0200 Subject: [PATCH] doc: Update README --- README.md | 18 +++++++++--------- package.json | 2 +- packages/cli/README.md | 18 +++++++++--------- packages/gatsby-plugin/README.md | 4 ++-- packages/next-plugin/README.md | 4 ++-- packages/utils/README.md | 4 ++-- packages/webpack-plugin/README.md | 18 +++++++++--------- 7 files changed, 34 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index e554ff2414..f7fa189135 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@

BundleStats

- Generate bundle report(bundle size, assets, modules, packages) and compare the results between different builds. + Analyze webpack stats(bundle size, assets, modules, packages) and compare the results between different builds.

@@ -16,12 +16,12 @@ RelativeCI

-- Bundle size and totals by file type(css, js, img, etc)
-- Cache invalidation, Initial JS/CSS and other bundle specific metrics
-- Assets report (entrypoint, initial, types, changed, delta)
-- Modules report (changed, delta) by chunk
-- Packages report (count, duplicate, changed, delta)
-:star: Side by side comparison for multiple jobs +- Bundle size and totals by file type(css, js, img, etc)
+- Cache invalidation, Initial JS/CSS and other bundle specific metrics
+- Assets report (entrypoint, initial, types, changed, delta)
+- Modules report (changed, delta) by chunk
+- Packages report (count, duplicate, changed, delta)
+:star: Side by side comparison for multiple builds

## Related projects @@ -30,9 +30,9 @@ Specialized insights for web bundles: -- Monitor and analyze bundle size, assets, modules, packages +- Analyze and monitor webpack stats(bundle size, assets, modules, packages) - GitHub Check, GitHub Pull Request, and Slack integrations -- Support for all major CI services (CircleCI, GitHub Actions, Travis CI CI, Jenkins, Gitlab CI, Codeship) +- Support for all major CI services (CircleCI, GitHub Actions, Gitlab CI, Jenkins, Travis CI) - Free for OpenSource, developers and small teams [Try for free](https://relative-ci.com?utm_source=github&utm_medium=bundle-stats) diff --git a/package.json b/package.json index 7b32229ed5..c471f8d6b3 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@bundle-state/bundle-stats", "private": true, - "description": "Generate bundle report(bundle size, assets, modules, packages) and compare the results between different builds.", + "description": "Analyze webpack stats(bundle size, assets, modules, packages) and compare the results between different builds.", "engines": { "node": ">= 12.0" }, diff --git a/packages/cli/README.md b/packages/cli/README.md index e451e1d08c..58954591c1 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -3,7 +3,7 @@

BundleStats

- Generate bundle report(bundle size, assets, modules, packages) and compare the results between different builds. + Analyze webpack stats(bundle size, assets, modules, packages) and compare the results between different builds.

@@ -13,12 +13,12 @@ Language grade: JavaScript

-- Bundle size and totals by file type(css, js, img, etc)
-- Cache invalidation, Initial JS/CSS and other bundle specific metrics
-- Assets report (entrypoint, initial, types, changed, delta)
-- Modules report (changed, delta) by chunk
-- Packages report (count, duplicate, changed, delta)
-:star: Side by side comparison for multiple jobs +- Bundle size and totals by file type(css, js, img, etc)
+- Cache invalidation, Initial JS/CSS and other bundle specific metrics
+- Assets report (entrypoint, initial, types, changed, delta)
+- Modules report (changed, delta) by chunk
+- Packages report (count, duplicate, changed, delta)
+:star: Side by side comparison for multiple builds

## Table of Contents @@ -183,9 +183,9 @@ The option can be disabled using `--no-compare` option. Specialized insights for web bundles: -- Monitor and analyze bundle size, assets, modules, packages +- Analyze and monitor webpack stats(bundle size, assets, modules, packages) - GitHub Check, GitHub Pull Request, and Slack integrations -- Support for all major CI services (CircleCI, GitHub Actions, Travis CI CI, Jenkins, Gitlab CI, Codeship) +- Support for all major CI services (CircleCI, GitHub Actions, Gitlab CI, Jenkins, Travis CI) - Free for OpenSource, developers and small teams [Try for free](https://relative-ci.com?utm_source=github&utm_medium=bundle-stats) diff --git a/packages/gatsby-plugin/README.md b/packages/gatsby-plugin/README.md index 718bfb531f..0b3b0d3864 100644 --- a/packages/gatsby-plugin/README.md +++ b/packages/gatsby-plugin/README.md @@ -61,9 +61,9 @@ module.exports = { Specialized insights for web bundles: -- Monitor and analyze bundle size, assets, modules, packages +- Analyze and monitor webpack stats(bundle size, assets, modules, packages) - GitHub Check, GitHub Pull Request, and Slack integrations -- Support for all major CI services (CircleCI, GitHub Actions, Travis CI CI, Jenkins, Gitlab CI, Codeship) +- Support for all major CI services (CircleCI, GitHub Actions, Gitlab CI, Jenkins, Travis CI) - Free for OpenSource, developers and small teams [Try for free](https://relative-ci.com?utm_source=github&utm_medium=bundle-stats) diff --git a/packages/next-plugin/README.md b/packages/next-plugin/README.md index 8666ff1833..61d58ca876 100644 --- a/packages/next-plugin/README.md +++ b/packages/next-plugin/README.md @@ -49,9 +49,9 @@ module.exports = withBundleStats({ Specialized insights for web bundles: -- Monitor and analyze bundle size, assets, modules, packages +- Analyze and monitor webpack stats(bundle size, assets, modules, packages) - GitHub Check, GitHub Pull Request, and Slack integrations -- Support for all major CI services (CircleCI, GitHub Actions, Travis CI CI, Jenkins, Gitlab CI, Codeship) +- Support for all major CI services (CircleCI, GitHub Actions, Gitlab CI, Jenkins, Travis CI) - Free for OpenSource, developers and small teams [Try for free](https://relative-ci.com?utm_source=github&utm_medium=bundle-stats) diff --git a/packages/utils/README.md b/packages/utils/README.md index 247c0074f7..24aa560eae 100644 --- a/packages/utils/README.md +++ b/packages/utils/README.md @@ -41,9 +41,9 @@ console.log(report.insights.webpack.assetsSizeTotal.data.text); Specialized insights for web bundles: -- Monitor and analyze bundle size, assets, modules, packages +- Analyze and monitor webpack stats(bundle size, assets, modules, packages) - GitHub Check, GitHub Pull Request, and Slack integrations -- Support for all major CI services (CircleCI, GitHub Actions, Travis CI CI, Jenkins, Gitlab CI, Codeship) +- Support for all major CI services (CircleCI, GitHub Actions, Gitlab CI, Jenkins, Travis CI) - Free for OpenSource, developers and small teams [Try for free](https://relative-ci.com?utm_source=github&utm_medium=bundle-stats) diff --git a/packages/webpack-plugin/README.md b/packages/webpack-plugin/README.md index ced21948b8..bee00452c7 100644 --- a/packages/webpack-plugin/README.md +++ b/packages/webpack-plugin/README.md @@ -3,7 +3,7 @@

BundleStats

- Generate bundle report(bundle size, assets, modules, packages) and compare the results between different builds. + Analyze webpack stats(bundle size, assets, modules, packages) and compare the results between different builds.

@@ -13,12 +13,12 @@ Language grade: JavaScript

-- Bundle size and totals by file type(css, js, img, etc)
-- Cache invalidation, Initial JS/CSS and other bundle specific metrics
-- Assets report (entrypoint, initial, types, changed, delta)
-- Modules report (changed, delta) by chunk
-- Packages report (count, duplicate, changed, delta)
-:star: Side by side comparison for multiple jobs +- Bundle size and totals by file type(css, js, img, etc)
+- Cache invalidation, Initial JS/CSS and other bundle specific metrics
+- Assets report (entrypoint, initial, types, changed, delta)
+- Modules report (changed, delta) by chunk
+- Packages report (count, duplicate, changed, delta)
+:star: Side by side comparison for multiple builds

## Table of Contents @@ -148,9 +148,9 @@ The option can be disabled by setting `BundleStatsWebpackPlugin` `compare` optio Specialized insights for web bundles: -- Monitor and analyze bundle size, assets, modules, packages +- Analyze and monitor webpack stats(bundle size, assets, modules, packages) - GitHub Check, GitHub Pull Request, and Slack integrations -- Support for all major CI services (CircleCI, GitHub Actions, Travis CI CI, Jenkins, Gitlab CI, Codeship) +- Support for all major CI services (CircleCI, GitHub Actions, Gitlab CI, Jenkins, Travis CI) - Free for OpenSource, developers and small teams [Try for free](https://relative-ci.com?utm_source=github&utm_medium=bundle-stats)