From 31d7c4bec9eeb489130142394c724fa0fd2eeae1 Mon Sep 17 00:00:00 2001 From: Simon Lecoq <22963968+lowlighter@users.noreply.github.com> Date: Thu, 10 Dec 2020 13:54:47 +0100 Subject: [PATCH] Update README.md --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 585f4911cb5..197c51cb679 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # 📊 GitHub metrics -![Build](https://github.com/lowlighter/metrics/workflows/Build/badge.svg) ![Analysis](https://github.com/lowlighter/metrics/workflows/Analysis/badge.svg) +![Build](https://github.com/lowlighter/metrics/workflows/Build/badge.svg) Generates your own GitHub metrics as an SVG image to put them on your profile page or elsewhere ! @@ -97,6 +97,12 @@ jobs: See all supported options in [action.yml](https://github.com/lowlighter/metrics/blob/master/action.yml). +#### Preview vs release + +It is possible to use `lowlighter/metrics@master` instead of `lowlighter/metrics@latest` to get new features before their release, but some breaking changes may occur occasionally which could result in your metrics not being generated. + +#### What will happen ? + A new SVG image will be generated and committed to your repository on each run. Because of this, the amount of your commits could be virtually increased which is probably unwanted. @@ -353,6 +359,22 @@ Add the following to your workflow : plugin_pagespeed_token: ${{ secrets.PAGESPEED_TOKEN }} ``` +It is possible to generate a detailled report along with scores : + +![Pagespeed plugin](https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.pagespeed.detailed.svg) + +See [performance scoring](https://web.dev/performance-scoring/) and [score calculator](https://googlechrome.github.io/lighthouse/scorecalc/) for more information about how PageSpeed compute these metrics. + +Add the following to your workflow instead : +```yaml +- uses: lowlighter/metrics@latest + with: + # ... other options + plugin_pagespeed: yes + plugin_pagespeed_detailed: yes + plugin_pagespeed_token: ${{ secrets.PAGESPEED_TOKEN }} +``` + ### 🎼 Music