diff --git a/README.md b/README.md index aa57f6a..6d68cb0 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,34 @@ psi-action status # psi-action - -TODO +psi-action is a GitHub Action that outputs [PageSpeed Insights](https://pagespeed.web.dev/) values for the next steps of a workflow. This action is similar to [JakePartusch/psi-action](https://github.com/JakePartusch/psi-action), but different in that this actually outputs the values for further use in the workflow. ## Inputs - -- TODO +- `url`: The URL to fetch PageSpeed Insights results. +- `key`: API Key for the PageSpeed Insights API. +- `strategy`: Strategy to fetch PageSpeed Insights results. "mobile" or "desktop". ## Outputs - -- TODO +- `score`: Overall score of the url. Maximum is 100. +- `first-contentful-paint`: First Contentful Paint (FCP) in milliseconds. +- `first-input-delay`: First Input Delay (FID) in milliseconds. +- `cumulative-layout-shift`: Cumulative Layout Shift (CLS) score. +- `largest-contentful-paint`: Largest Contentful Paint (LCP) in milliseconds. +- `speed-index`: Speed Index score. Maximum is 100. +- `time-to-interactive`: Time to Interactive score. Maximum is 100. +- `total-blocking-time`: Total Blocking Time score. Maximum is 100. ## Example Usage -TODO +```yaml + - id: psi + uses: stefafafan/psi-action@v1 + with: + url: 'https://example.com/' + key: ${{ secrets.API_KEY }} + strategy: 'mobile' + - name: echo score + run: echo "Score: ${{ steps.psi.outputs.score }}" +``` ## Contributing diff --git a/action.yml b/action.yml index ff70e52..28025cd 100644 --- a/action.yml +++ b/action.yml @@ -32,3 +32,6 @@ outputs: runs: using: 'node16' main: 'dist/index.js' +branding: + icon: 'trending-up' + color: 'blue' diff --git a/package.json b/package.json index 0a4038e..97dbe56 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "psi-action", - "version": "0.0.0", + "version": "1.0.0", "private": true, "description": "PageSpeed Insights Action", "main": "lib/main.js",