updated the readme file

Author: yunchengyang515

.github/workflows/example-workflows.yml

@@ -41,4 +41,3 @@ jobs:
         stackql exec -i ./examples/google-example.iql --auth="${AUTH}"
       env:
         AUTH: ${{ vars.AUTH }}  ## '{ "google": { "type": "service_account",  "credentialsfilepath": "sa-key.json" }}'
-        GOOGLE_CREDS: ${{ secrets.GOOGLE_CREDS }}

README.md

@@ -5,12 +5,24 @@ The `stackql/setup-stackql` action is a JavaScript action that sets up Terraform
 - Downloading a latest Stackql CLI and adding it to the `PATH`.
 - Setup AUTH env var in the Github Action
 
-## Auth object string
-Example
+# Auth
+### Basic Example
+1. Set Auth variable:
 ```
-{   
-    "google": { "credentialsfilepath": "creds/stackql-demo.json",  "type": "service_account" }, 
-    "okta": { "credentialsenvvar": "OKTA_SECRET_KEY", "type": "api_key", credentials: '<your credentials>' }
-}
+{ "github": { "type": "basic", "credentialsenvvar": "STACKQL_GITHUB_CREDS" } }
 ```
+2. create the github token as a secret
+3. In the execution step, pass the secret as environment variable with name "STACKQL_GITHUB_CREDS"
 
+Check the "Use GitHub Provider" step in `.github/workflows/example-workflows.yml`
+
+### json File Auth example
+
+1. Set Auth variable:
+```
+{ "google": { "type": "service_account",  "credentialsfilepath": "sa-key.json" }}
+```
+2. encode the key json file into base64 string
+3. in execution step, run `sudo echo ${{ secrets.<name of the secret> }} | base64 -d > sa-key.json`
+
+Check the "Use Google Provider" step in `.github/workflows/example-workflows.yml`