Update README.md with a better example of how to use this Action

Signed-off-by: Avi Miller <avi.miller@oracle.com>

Author: Djelibeybi

README.md

@@ -1,55 +1,47 @@
 # run-oci-cli-command v1.0
 
-This GitHub Action installs the OCI CLI and then runs the specified command.
-This action will automatically cache the OCI CLI install to speed up any
-subsequent steps that use this action.
+This GitHub Action installs the OCI CLI and then runs the specified command. This action will automatically cache the OCI CLI install to speed up any subsequent steps that use this action.
 
 ## Required environment variables
 
-The following [OCI CLI environment variables][1] must be defined for at least
-the `run-oci-cli-command` task:
+The following [OCI CLI environment variables][1] must be defined for at least the `run-oci-cli-command` task:
 
 * `OCI_CLI_USER`
 * `OCI_CLI_TENANCY`
 * `OCI_CLI_FINGERPRINT`
 * `OCI_CLI_KEY_CONTENT`
 * `OCI_CLI_REGION`
 
-We recommend using GitHub Secrets to store these values. If you have more than
-one `run-oci-cli-command` task, consider [defining your environment variables][2] at
-the job or workflow level.
+We recommend using GitHub Secrets to store these values. If you have more than one `run-oci-cli-command` task, consider [defining your environment variables][2] at the job or workflow level.
 
 ## Inputs
 
 * `command` (required): the [command and arguments][3] to provide to the `oci` tool.
-* `query`: (optional) a [JMESPath query](http://jmespath.org/) to run on the
-  response JSON before output.
+* `query`: (optional) a [JMESPath query][4] to run on the  response JSON before output.
 
 ### Output masking
 
-By default, the output(s) from the command are masked from the GitHub Actions log
-and GitHub console, to prevent leaking any credential or confidential information.
-The following option will disable that masking and is intended for debugging
-purposes only:
+By default, the output(s) from the command are masked from the GitHub Actions log and GitHub console, to prevent leaking any credential or confidential information. The following option will disable that masking and is intended for debugging purposes only:
 
-* `silent`: (Optional; default: _true_) If set to _false_ the  action will
-  not mask or suppress the command or outputs from the logs or console.
+* `silent`: (Optional; default: _true_) If set to _false_ the  action will   not mask or suppress the command or outputs from the logs or console.
 
-> **Note:** the output does not need to be visible in the log to be used as an
-> input by another task.
+> **Note:** the output does not need to be visible in the log to be used as an > input by another task.
 
 ## Outputs
 
 * `output`: will contain the results of the command in JSON format.
-* `raw_output`: if the output of a given query is a single string value, this
-  will return the string without surrounding quotes.
+* `raw_output`: if the output of a given query is a single string value, this   will return the string without surrounding quotes.
 
-> **Note:** filtering the `output` or `raw_output` by piping it through another
-> tool like `jq` may result in the filtered output being visible in the job
-> logs. _Using a JMESPath query to filter results is recommend instead_.
+> **Note:** filtering the `output` or `raw_output` by piping it through another tool like `jq` may result in the filtered output being visible in the job logs. We recommend using the `query` parameter instead.
 
 ## Sample workflow
 
+The following example lists all compute instances found in the `testing` compartment of the `OCI_CLI_TENANCY` in the `OCI_CLI_REGION` region.
+
+To change the name of the compartment, modifying the `query` parameter of the `find-compartment-id` step.
+
+To change which fields are returned, modify the `query` parameter of the `find-instasnces` step.
+
 ```yaml
 jobs:
   my-instances:
@@ -63,25 +55,25 @@ jobs:
       OCI_CLI_REGION: ${{ secrets.OCI_CLI_REGION }}
     steps:
       - name: Retrieve the OCID of a named compartment in tenancy
-        uses: oracle-actions/run-oci-cli-command@v1
-        id: get-compartment-ocid
+        uses: oracle-actions/run-oci-cli-command@v1.0
+        id: find-compartment-id
         with:
-          command: 'iam compartment list'
-          jmespath: "data[?name=='my-compartment'].id"
+          command: 'iam compartment list --compartment-id-in-subtree=true'
+          query: "data[?name=='testing'].id"
 
       - name: Retrieve the display name and shape of the instances in my compartment
         uses: oracle-actions/run-oci-cli-command@v1.0
-        id: find-my-instances-instances
+        id: find-instances
         with:
-          command: 'compute instance list --compartment-id ${{ steps.compartment-ocid.get-compartment-ocid.raw_output }}'
-          jmespath: 'data[*].{name: \"display-name\", shape: shape}'
+          command: 'compute instance list --compartment-id ${{ steps.find-compartment-id.outputs.raw_output }}'
+          query: 'data[*].{name: \"display-name\", shape: shape}'
 
       - name: List the display name and shape of the instances in my compartment
         run: |
           echo ${{ steps.find-my-compartment-instances.outputs.output }} | jq .
 ```
 
-See [`action.yml`](./action.yml) for more details.
+ Consult the [JMESPath documentation][4] for details on how to create more complex queries and result formatting and [`action.yml`](./action.yml) for more detail on how to configure this action..
 
 ## Contributing
 
@@ -103,3 +95,4 @@ Released under the Universal Permissive License v1.0 as shown at
 [1]: https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/clienvironmentvariables.htm
 [2]: https://docs.github.com/en/actions/learn-github-actions/environment-variables
 [3]: https://docs.oracle.com/en-us/iaas/tools/oci-cli/3.2.0/oci_cli_docs/
+[4]: https://jmespath.org/