diff --git a/packages/oidc-client/README.md b/packages/oidc-client/README.md index e14194b4..89bd064f 100644 --- a/packages/oidc-client/README.md +++ b/packages/oidc-client/README.md @@ -2,7 +2,7 @@

Usage

-You can use this package to interact with the github oidc provider. +You can use this package to interact with the GitHub OIDC provider and get a JWT ID token which would help to get access token from third party cloud providers.

Get the ID token

@@ -12,6 +12,10 @@ Method Name: getIDToken audience : optional +

Outputs

+ +A [JWT](https://jwt.io/) ID Token + You can use this [template](https://github.com/actions/typescript-action) to use the package.

Example:

@@ -21,7 +25,7 @@ const core = require('@actions/core'); const id = require('@actions/oidc-client') -async function getID(): Promise { +async function getIDTokenAction(): Promise { let aud = '' const audience = core.getInput('audience', {required: false}) @@ -33,7 +37,7 @@ async function getID(): Promise { } -getID() +getIDTokenAction() ``` actions.yml