diff --git a/README.md b/README.md index 679f4ac7..490fb73d 100644 --- a/README.md +++ b/README.md @@ -91,3 +91,19 @@ Create a `.env` file based on the [example](.env.example) and run yarn install yarn local ``` + +## Lighthouse Score Visualizations (Labs feature) + +When you install the [Lighthouse Build Plugin](https://app.netlify.com/plugins/@netlify/plugin-lighthouse/install) on your site and enable this experimental feature, you can view the Lighthouse scores for each of your builds on your site's Deploy Details page with a much richer format. + +Deploy view with Lighthouse visualizations + +If you have multiple audits (directories, paths, etc) defined in your build, we will display a roll-up of the average Lighthouse scores for all the current build's audits plus the results for each individual audit. + +Deploy details with multiple audit Lighthouse results + +Some items of note: +- The [Lighthouse Build Plugin](https://app.netlify.com/plugins/@netlify/plugin-lighthouse/install) must be installed on your site(s) in order for these score visualizations to be displayed. +- This Labs feature is currently only enabled at the user-level, so it will need to be enabled for each individual team member that wishes to see the Lighthouse scores displayed. + +We have a lot planned for this feature and will be adding functionality regularly, but we'd also love to hear your thoughts. Please [share your feedback](https://netlify.qualtrics.com/jfe/form/SV_1NTbTSpvEi0UzWe) about this experimental feature and tell us what you think.