Upgrade run-gemini-cli README.md (#49)

Closes #43

This rebases @8bitmp3's changes against main.

---------

Signed-off-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>
Co-authored-by: 8bitmp3 <19637339+8bitmp3@users.noreply.github.com>

Author: sethvargo

README.md

@@ -1,10 +1,9 @@
 # run-gemini-cli
 
-This action invokes the Gemini CLI. Use this to automate software development
-tasks within your GitHub repositories with [Gemini CLI].
-
-You can interact with Gemini by mentioning it in pull request comments and
-issues to perform tasks like code generation, analysis, and modification.
+`run-gemini-cli` is a GitHub Action that integrates [Gemini] AI into your development
+workflow via the [Gemini CLI]. You can use it to perform GitHub pull request reviews, triage
+issues, perform code analysis and modification, and more using [Gemini] conversationally
+(e.g., `@gemini-cli /review`) directly inside your GitHub repositories.
 
 **This is not an officially supported Google product, and it is not covered by a
 Google Cloud support contract. To report bugs or request features in a Google
@@ -30,16 +29,16 @@ Cloud product, please contact [Google Cloud support].**
 
 ## Features
 
-- **Extensible with Tools**: Leverage Gemini's tool-calling capabilities to
-  interact with other CLIs like the `gh` CLI for powerful automations.
+- **Extensible with Tools**: Leverage [Gemini] models' tool-calling capabilities to
+  interact with other CLIs like the [GitHub CLI] (`gh`) for powerful automations.
 - **Customizable**: Use a `GEMINI.md` file in your repository to provide
-  project-specific instructions and context to Gemini.
+  project-specific instructions and context to [Gemini CLI].
 - **Comment-based Interaction**: Trigger workflows in issue and pull request
-  comments.
+  comments by mentioning the [Gemini CLI] (e.g., `@gemini-cli /review`).
 
 ## Getting Started
 
-Before using this action, you need to:
+Before using the Gemini CLI GitHub Action, make sure to:
 
 1.  **Get a Gemini API Key**: Obtain your API key from [Google AI Studio].
 2.  **Add it as a GitHub Secret**: Store your API key as a secret in your
@@ -48,7 +47,7 @@ Before using this action, you need to:
 
 ## Configuration
 
-This action is configured via a combination of workflow inputs, outputs,
+The Gemini CLI GitHub Action is configured via a combination of workflow inputs, outputs,
 environment variables, and secrets.
 
 ### Inputs
@@ -78,49 +77,48 @@ Set the following environment variables in your repository or workflow:
 
 | Name                      | Description                                                                                 | Type     | Required | When Required                |
 |---------------------------|---------------------------------------------------------------------------------------------|----------|----------|------------------------------|
-| GEMINI_CLI_VERSION        | Controls which version of the Gemini CLI is installed. Supports npm versions (e.g., `0.1.0`, `latest`), a branch name (e.g., `main`), or a commit hash. | Variable | No       | To pin or override CLI version |
-| GCP_WIF_PROVIDER     | The full resource name of the Workload Identity Provider.                                   | Variable | No       | If using observability       |
-| OTLP_GOOGLE_CLOUD_PROJECT | The Google Cloud project for telemetry.                                                     | Variable | No       | If using observability       |
-| GOOGLE_CLOUD_PROJECT      | The Google Cloud project for Vertex auth.                                                   | Variable | No       | If using Vertex auth         |
-| GOOGLE_CLOUD_LOCATION     | The location of the Google Cloud project for Vertex auth.                                   | Variable | No       | If using Vertex auth         |
-| GOOGLE_GENAI_USE_VERTEXAI | Set to 'true' to use Vertex AI                                                  | Variable | No       | If using Vertex auth |
-| APP_ID                    | GitHub App ID for custom authentication.                                                    | Variable | No       | If using a custom GitHub App |
-
-
-To add an environment variable, go to your repository's **Settings > Secrets and
-variables > Actions > New variable**. Enter the variable name and value, then
-save. For organization-wide or environment-specific variables, see the
+| GEMINI_CLI_VERSION        | Controls which version of the Gemini CLI is installed. Supports `npm` versions (e.g., `0.1.0`, `latest`), a branch name (e.g., `main`), or a commit hash. | Variable | No       | To pin or override the CLI version |
+| GCP_WIF_PROVIDER          | Full resource name of the Workload Identity Provider.                                       | Variable | No       | When using observability               |
+| OTLP_GOOGLE_CLOUD_PROJECT | Google Cloud project for telemetry.                                                         | Variable | No       | When using observability               |
+| GOOGLE_CLOUD_PROJECT      | Google Cloud project for Vertex AI authentication.                                          | Variable | No       | When using Vertex AI authentication    |
+| GOOGLE_CLOUD_LOCATION     | Geographic location of the Google Cloud project for Vertex AI authentication.               | Variable | No       | When using Vertex AI authentication    |
+| GOOGLE_GENAI_USE_VERTEXAI | Set to 'true' to use Vertex AI                                                              | Variable | No       | When using Vertex AI authentication    |
+| APP_ID                    | GitHub App ID for custom authentication.                                                    | Variable | No       | When using a custom GitHub App         |
+
+
+To add an environment variable: 1) Go to your repository's **Settings > Secrets and
+variables > Actions > New variable**; 2) Enter the variable name and value; and 3) Save.
+For organization-wide or environment-specific variables, refer to the
 [GitHub documentation on variables][variables].
 
 ### Secrets
 
 The following secrets are required for security:
 
-| Name              | Description                                   | Required | When Required                          |
-|-------------------|-----------------------------------------------|----------|----------------------------------------|
-| GEMINI_API_KEY    | Your Gemini API key.                          | No       | If using API key from AI Studio |
-| APP_PRIVATE_KEY   | Private key for your GitHub App (PEM format). | No       | If using a custom GitHub App           |
+| Name              | Description                                   | Required | When Required                                             |
+|-------------------|-----------------------------------------------|----------|-----------------------------------------------------------|
+| GEMINI_API_KEY    | Your Gemini API key from Google AI Studio.    | No       | If you are using the Gemini API key from Google AI Studio |
+| APP_PRIVATE_KEY   | Private key for your GitHub App (PEM format). | No       | If you are using a custom GitHub App                      |
 
 To add a secret, go to your repository's **Settings > Secrets and variables >
-Actions > New repository secret**. For more information, see the
+Actions > New repository secret**. For more information, refer to the
 [official GitHub documentation on creating and using encrypted secrets][secrets].
 
 ## Workflows
 
-To use this action, create a workflow file in your repository (e.g.,
-`.github/workflows/gemini.yml`).
-
-The best way to get started is to copy one of the pre-built workflows from the
+Workflows include Issue Triage, Pull Request Review. and Generic Gemini CLI. To use
+this GitHub Action, you need to create a workflow file in your repository (e.g.,
+`.github/workflows/gemini.yml`). The best way to get started is to copy one of the pre-built workflows from the
 [`/workflows`](./workflows) directory into your project's `.github/workflows`
 folder and customize it.
 
-See the sections below for specific examples.
+Below are specific examples of workflows:
 
 ### Issue Triage
 
-This action can be used to triage GitHub issues automatically or on a schedule.
-For a detailed guide on how to set up the issue triage system, please see the
-[documentation](./workflows/issue-triage).
+This action can be used to triage GitHub Issues automatically or on a schedule.
+For a detailed guide on how to set up the issue triage system, go to the
+[GitHub Issue Triage workflow documentation](./workflows/issue-triage).
 
 ### Pull Request Review
 
@@ -129,20 +127,20 @@ opened. Additionally, users with `OWNER`, `MEMBER`, or `COLLABORATOR`
 permissions can trigger a review by commenting `@gemini-cli /review` in a pull
 request.
 
-For a detailed guide on how to set up the pull request review system, please see
-the [documentation](./workflows/pr-review).
+For a detailed guide on how to set up the pull request review system, go to the
+[GitHub PR Review workflow documentation](./workflows/pr-review).
 
 ### Generic Gemini CLI
 
-This action can be used to invoke a general-purpose, conversational AI assistant
-that can be invoked within pull requests and issues to perform a wide range of
-tasks. For a detailed guide on how to set up the Gemini CLI, please see the
-[documentation](./workflows/gemini-cli).
+This type of action can be used to invoke a general-purpose, conversational Gemini
+AI assistant within the pull requests and issues to perform a wide range of
+tasks. For a detailed guide on how to set up the [Gemini CLI], go to the Generic
+[Gemini CLI workflow documentation](./workflows/gemini-cli).
 
-You can configure the [maxSessionTurns](https://github.com/google-gemini/gemini-cli/blob/main/docs/cli/configuration.md#available-settings-in-settingsjson)
-when running the gemini cli in the workflow's yml file if you want to restrict
-maximum session turns for each yolo gemini cli run. In the step 'Run Gemini',
-you can configure the maxSessionTurns in the settings.
+You can configure the [`maxSessionTurns`](https://github.com/google-gemini/gemini-cli/blob/main/docs/cli/configuration.md#available-settings-in-settingsjson)
+when running the Gemini CLI in the workflow's YAML configuration file if you want to restrict
+the maximum number of session turns for each of the `yolo` Gemini CLI runs. In the 'Run Gemini' step ,
+you can configure the `maxSessionTurns` in the settings.
 
 ## Authentication
 
@@ -155,41 +153,43 @@ authenticate in two ways:
     default `GITHUB_TOKEN` provided by the workflow.
 
 For a detailed guide on how to set up authentication, including creating a
-custom app and the required permissions, please see the
+custom app and the required permissions, go to the
 [**Authentication documentation**](./docs/github-app.md).
 
 ## Observability with OpenTelemetry
 
 This action can be configured to send telemetry data (traces, metrics, and logs)
 to your own Google Cloud project. This allows you to monitor the performance and
-behavior of the Gemini CLI within your workflows, providing valuable insights
+behavior of the [Gemini CLI] within your workflows, providing valuable insights
 for debugging and optimization.
 
-For detailed instructions on how to set up and configure observability, please
-see the [Observability documentation](./docs/observability.md).
+For detailed instructions on how to set up and configure observability, go to
+the [Observability documentation](./docs/observability.md).
 
 ### OpenTelemetry in Google Cloud
 
 To use observability features with Google Cloud, you'll need to set up Workload
-Identity Federation. For detailed setup instructions, see the
+Identity Federation. For detailed setup instructions, check out the
 [Workload Identity Federation documentation](./docs/workload-identity.md).
 
 ## Customization
 
 Create a `GEMINI.md` file in the root of your repository to provide
-project-specific context and instructions to Gemini. This is useful for defining
+project-specific context and instructions to [Gemini CLI]. This is useful for defining
 coding conventions, architectural patterns, or other guidelines the model should
 follow.
 
 ## Contributing
 
-Contributions are welcome! Please see our
+Contributions are welcome! Check out the Gemini CLI
 [**Contributing Guide**](./CONTRIBUTING.md) for more details on how to get
 started.
 
 [secrets]: https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions
 [settings_json]: https://github.com/google-gemini/gemini-cli/blob/main/docs/
+[Gemini]: https://deepmind.google/models/gemini/
 [Google AI Studio]: https://aistudio.google.com/apikey
-[Gemini CLI]: https://github.com/google-github-actions/run-gemini-cli
+[Gemini CLI]: https://github.com/google-gemini/gemini-cli/
 [Google Cloud support]: https://cloud.google.com/support
 [variables]: https://docs.github.com/en/actions/learn-github-actions/variables
+[GitHub CLI]: https://docs.github.com/en/github-cli/github-cli