chore: Update READMEs

relative-ci · Jul 24, 2023 · 691abdc · 691abdc
1 parent 0e6221a
commit 691abdc
Show file tree

Hide file tree

Showing 5 changed files with 191 additions and 3 deletions.
diff --git a/packages/cli-utils/README.md b/packages/cli-utils/README.md
@@ -2,7 +2,33 @@
 
 [![](https://img.shields.io/npm/v/@bundle-stats/cli-utils)](https://www.npmjs.com/package/@bundle-stats/cli-utils)
 
-CLI utilities for BundleStats
+CLI utilities for [bundle-stats](https://github.com/relative-ci/bundle-stats)
+
+## Related projects
+
+### :cyclone: [relative-ci.com](https://relative-ci.com?utm_medium=bundle-stats)
+
+#### In-depth webpack bundle analysis and monitoring
+
+RelativeCI automates webpack bundle analysis, monitoring, and alerting so you can identify and fix bundle regressions before shipping to production:
+
+- :crystal_ball: Analyze webpack bundle stats on every build
+- :chart_with_upwards_trend: Monitor webpack bundle stats changes and identify tendencies over extended periods
+- :bell: Get notified via GitHub Checks, GitHub Pull Request comments, and Slack notifications
+- :hammer: Support for all major CI services (CircleCI, GitHub Actions, Gitlab CI, Jenkins, Travis CI)
+- :two_hearts: Always free for Open Source
+
+[Try for free](https://relative-ci.com?utm_medium=bundle-stats)
+
+### :first_quarter_moon: [relative-ci/compare](https://compare.relative-ci.com)
+
+Standalone web application to compare Webpack/Lighthouse/Browsertime stats.
+
+[Compare bundle stats](https://compare.relative-ci.com)
+
+### :zap: [bundle-stats-action](https://github.com/vio/bundle-stats-action)
+
+Github Action that generates [bundle-stats](https://github.com/relative-ci/bundle-stats) reports.
 
 ## Packages
 

diff --git a/packages/html-templates/README.md b/packages/html-templates/README.md
@@ -3,7 +3,33 @@
 [![](https://img.shields.io/npm/v/html-templates.svg)](https://www.npmjs.com/package/html-templates)
 [![Relative CI](https://badges.relative-ci.com/badges/V1bXuieJbYttHCS75L8G)](https://app.relative-ci.com/projects/V1bXuieJbYttHCS75L8G)
 
-HTML templates for report generation.
+HTML report for [bundle-stats](https://github.com/relative-ci/bundle-stats)
+
+## Related projects
+
+### :cyclone: [relative-ci.com](https://relative-ci.com?utm_medium=bundle-stats)
+
+#### In-depth webpack bundle analysis and monitoring
+
+RelativeCI automates webpack bundle analysis, monitoring, and alerting so you can identify and fix bundle regressions before shipping to production:
+
+- :crystal_ball: Analyze webpack bundle stats on every build
+- :chart_with_upwards_trend: Monitor webpack bundle stats changes and identify tendencies over extended periods
+- :bell: Get notified via GitHub Checks, GitHub Pull Request comments, and Slack notifications
+- :hammer: Support for all major CI services (CircleCI, GitHub Actions, Gitlab CI, Jenkins, Travis CI)
+- :two_hearts: Always free for Open Source
+
+[Try for free](https://relative-ci.com?utm_medium=bundle-stats)
+
+### :first_quarter_moon: [relative-ci/compare](https://compare.relative-ci.com)
+
+Standalone web application to compare Webpack/Lighthouse/Browsertime stats.
+
+[Compare bundle stats](https://compare.relative-ci.com)
+
+### :zap: [bundle-stats-action](https://github.com/vio/bundle-stats-action)
+
+Github Action that generates [bundle-stats](https://github.com/relative-ci/bundle-stats) reports.
 
 ## Packages
 

diff --git a/packages/plugin-webpack-filter/README.md b/packages/plugin-webpack-filter/README.md
@@ -0,0 +1,55 @@
+# plugin-webpack-filter
+
+Webpack filter plugin for [bundle-stats](https://github.com/relative-ci/bundle-stats#README)
+
+## Related projects
+
+### :cyclone: [relative-ci.com](https://relative-ci.com?utm_medium=bundle-stats)
+
+#### In-depth webpack bundle analysis and monitoring
+
+RelativeCI automates webpack bundle analysis, monitoring, and alerting so you can identify and fix bundle regressions before shipping to production:
+
+- :crystal_ball: Analyze webpack bundle stats on every build
+- :chart_with_upwards_trend: Monitor webpack bundle stats changes and identify tendencies over extended periods
+- :bell: Get notified via GitHub Checks, GitHub Pull Request comments, and Slack notifications
+- :hammer: Support for all major CI services (CircleCI, GitHub Actions, Gitlab CI, Jenkins, Travis CI)
+- :two_hearts: Always free for Open Source
+
+[Try for free](https://relative-ci.com?utm_medium=bundle-stats)
+
+### :first_quarter_moon: [relative-ci/compare](https://compare.relative-ci.com)
+
+Standalone web application to compare Webpack/Lighthouse/Browsertime stats.
+
+[Compare bundle stats](https://compare.relative-ci.com)
+
+### :zap: [bundle-stats-action](https://github.com/vio/bundle-stats-action)
+
+Github Action that generates [bundle-stats](https://github.com/relative-ci/bundle-stats) reports.
+
+## Packages
+
+### [`bundle-stats`](https://github.com/relative-ci/bundle-stats/tree/master/packages/cli)
+
+[![npm](https://img.shields.io/npm/v/bundle-stats)](https://www.npmjs.com/package/bundle-stats) [![npm](https://img.shields.io/npm/dm/bundle-stats)](https://www.npmjs.com/package/bundle-stats)
+
+CLI to generate bundle stats report.
+
+### [`bundle-stats-webpack-plugin`](https://github.com/relative-ci/bundle-stats/tree/master/packages/webpack-plugin)
+
+[![npm](https://img.shields.io/npm/v/bundle-stats-webpack-plugin)](https://www.npmjs.com/package/bundle-stats-webpack-plugin) [![npm](https://img.shields.io/npm/dm/bundle-stats-webpack-plugin)](https://www.npmjs.com/package/bundle-stats-webpack-plugin)
+
+Webpack plugin to generate bundle stats report.
+
+### [`gatsby-plugin-bundle-stats`](https://github.com/relative-ci/bundle-stats/tree/master/packages/gatsby-plugin)
+
+[![npm](https://img.shields.io/npm/v/gatsby-plugin-bundle-stats)](https://www.npmjs.com/package/gatsby-plugin-bundle-stats) [![npm](https://img.shields.io/npm/dm/gatsby-plugin-bundle-stats)](https://www.npmjs.com/package/gatsby-plugin-bundle-stats)
+
+[Gatsby](https://www.gatsbyjs.org) plugin for [bundle-stats](https://github.com/relative-ci/bundle-stats/tree/master/packages/webpack-plugin).
+
+### [`next-plugin-bundle-stats`](https://github.com/relative-ci/bundle-stats/tree/master/packages/next-plugin)
+
+[![npm](https://img.shields.io/npm/v/next-plugin-bundle-stats)](https://www.npmjs.com/package/next-plugin-bundle-stats) [![npm](https://img.shields.io/npm/dm/next-plugin-bundle-stats)](https://www.npmjs.com/package/next-plugin-bundle-stats)
+
+[Next.js](https://nextjs.org) plugin for [bundle-stats](https://github.com/relative-ci/bundle-stats/tree/master/packages/webpack-plugin).
diff --git a/packages/plugin-webpack-validate/README.md b/packages/plugin-webpack-validate/README.md
@@ -0,0 +1,55 @@
+# plugin-webpack-validate
+
+Webpack validator plugin for [bundle-stats](https://github.com/relative-ci/bundle-stats#README)
+
+## Related projects
+
+### :cyclone: [relative-ci.com](https://relative-ci.com?utm_medium=bundle-stats)
+
+#### In-depth webpack bundle analysis and monitoring
+
+RelativeCI automates webpack bundle analysis, monitoring, and alerting so you can identify and fix bundle regressions before shipping to production:
+
+- :crystal_ball: Analyze webpack bundle stats on every build
+- :chart_with_upwards_trend: Monitor webpack bundle stats changes and identify tendencies over extended periods
+- :bell: Get notified via GitHub Checks, GitHub Pull Request comments, and Slack notifications
+- :hammer: Support for all major CI services (CircleCI, GitHub Actions, Gitlab CI, Jenkins, Travis CI)
+- :two_hearts: Always free for Open Source
+
+[Try for free](https://relative-ci.com?utm_medium=bundle-stats)
+
+### :first_quarter_moon: [relative-ci/compare](https://compare.relative-ci.com)
+
+Standalone web application to compare Webpack/Lighthouse/Browsertime stats.
+
+[Compare bundle stats](https://compare.relative-ci.com)
+
+### :zap: [bundle-stats-action](https://github.com/vio/bundle-stats-action)
+
+Github Action that generates [bundle-stats](https://github.com/relative-ci/bundle-stats) reports.
+
+## Packages
+
+### [`bundle-stats`](https://github.com/relative-ci/bundle-stats/tree/master/packages/cli)
+
+[![npm](https://img.shields.io/npm/v/bundle-stats)](https://www.npmjs.com/package/bundle-stats) [![npm](https://img.shields.io/npm/dm/bundle-stats)](https://www.npmjs.com/package/bundle-stats)
+
+CLI to generate bundle stats report.
+
+### [`bundle-stats-webpack-plugin`](https://github.com/relative-ci/bundle-stats/tree/master/packages/webpack-plugin)
+
+[![npm](https://img.shields.io/npm/v/bundle-stats-webpack-plugin)](https://www.npmjs.com/package/bundle-stats-webpack-plugin) [![npm](https://img.shields.io/npm/dm/bundle-stats-webpack-plugin)](https://www.npmjs.com/package/bundle-stats-webpack-plugin)
+
+Webpack plugin to generate bundle stats report.
+
+### [`gatsby-plugin-bundle-stats`](https://github.com/relative-ci/bundle-stats/tree/master/packages/gatsby-plugin)
+
+[![npm](https://img.shields.io/npm/v/gatsby-plugin-bundle-stats)](https://www.npmjs.com/package/gatsby-plugin-bundle-stats) [![npm](https://img.shields.io/npm/dm/gatsby-plugin-bundle-stats)](https://www.npmjs.com/package/gatsby-plugin-bundle-stats)
+
+[Gatsby](https://www.gatsbyjs.org) plugin for [bundle-stats](https://github.com/relative-ci/bundle-stats/tree/master/packages/webpack-plugin).
+
+### [`next-plugin-bundle-stats`](https://github.com/relative-ci/bundle-stats/tree/master/packages/next-plugin)
+
+[![npm](https://img.shields.io/npm/v/next-plugin-bundle-stats)](https://www.npmjs.com/package/next-plugin-bundle-stats) [![npm](https://img.shields.io/npm/dm/next-plugin-bundle-stats)](https://www.npmjs.com/package/next-plugin-bundle-stats)
+
+[Next.js](https://nextjs.org) plugin for [bundle-stats](https://github.com/relative-ci/bundle-stats/tree/master/packages/webpack-plugin).
diff --git a/packages/ui/README.md b/packages/ui/README.md
@@ -1,6 +1,32 @@
 # @bundle-stats/ui
 
-UI components for BundleStats projects.
+UI components for [bundle-stats](https://github.com/relative-ci/bundle-stats)
+
+## Related projects
+
+### :cyclone: [relative-ci.com](https://relative-ci.com?utm_medium=bundle-stats)
+
+#### In-depth webpack bundle analysis and monitoring
+
+RelativeCI automates webpack bundle analysis, monitoring, and alerting so you can identify and fix bundle regressions before shipping to production:
+
+- :crystal_ball: Analyze webpack bundle stats on every build
+- :chart_with_upwards_trend: Monitor webpack bundle stats changes and identify tendencies over extended periods
+- :bell: Get notified via GitHub Checks, GitHub Pull Request comments, and Slack notifications
+- :hammer: Support for all major CI services (CircleCI, GitHub Actions, Gitlab CI, Jenkins, Travis CI)
+- :two_hearts: Always free for Open Source
+
+[Try for free](https://relative-ci.com?utm_medium=bundle-stats)
+
+### :first_quarter_moon: [relative-ci/compare](https://compare.relative-ci.com)
+
+Standalone web application to compare Webpack/Lighthouse/Browsertime stats.
+
+[Compare bundle stats](https://compare.relative-ci.com)
+
+### :zap: [bundle-stats-action](https://github.com/vio/bundle-stats-action)
+
+Github Action that generates [bundle-stats](https://github.com/relative-ci/bundle-stats) reports.
 
 ## Packages