Update README.md
This commit is contained in:
24
README.md
24
README.md
@@ -1,6 +1,6 @@
|
|||||||
# 📊 GitHub metrics
|
# 📊 GitHub metrics
|
||||||
|
|
||||||
 
|

|
||||||
|
|
||||||
Generates your own GitHub metrics as an SVG image to put them on your profile page or elsewhere !
|
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).
|
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.
|
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.
|
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 }}
|
plugin_pagespeed_token: ${{ secrets.PAGESPEED_TOKEN }}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
It is possible to generate a detailled report along with scores :
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
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 }}
|
||||||
|
```
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
### 🎼 Music
|
### 🎼 Music
|
||||||
|
|||||||
Reference in New Issue
Block a user