Skip to content

Commit b6092dc

Browse files
authored
docs: update readme with form (#46)
1 parent 79641ae commit b6092dc

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

README.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,30 @@
66
Developers can effortlessly connect, interact, and generate data insights with [BigQuery](https://cloud.google.com/bigquery/docs) datasets and data using natural language commands.
77

88
Learn more about [Gemini CLI Extensions](https://github.com/google-gemini/gemini-cli/blob/main/docs/extensions/index.md).
9+
> [!IMPORTANT]
10+
> **We Want Your Feedback!**
11+
> Please share your thoughts with us by filling out our feedback [form][form].
12+
> Your input is invaluable and helps us improve the project for everyone.
13+
14+
[form]: https://docs.google.com/forms/d/e/1FAIpQLSfEGmLR46iipyNTgwTmIDJqzkAwDPXxbocpXpUbHXydiN1RTw/viewform?usp=pp_url&entry.157487=bigquery-data-analytics
915

1016
## Why Use the BigQuery Data Analytics Extension?
1117

1218
* **Natural Language to data analytics :** Find required BigQuery tables and ask analytical questions in natural language.
1319
* **Seamless Workflow:** Stay in your CLI. No need to constantly switch contexts to the GCP console for generating analytical insights.
1420
* **Run advanced analytics :** Generate forecasts, run a contributions analysis using built-in advanced tools.
1521

22+
1623
## Prerequisites
1724

1825
Before you begin, ensure you have the following:
1926

20-
* [Gemini CLI](https://github.com/google-gemini/gemini-cli) installed with version **+v0.6.0**.
21-
* A Google Cloud project with the **BigQuery API** enabled.
22-
* IAM Permissions:
23-
* BigQuery User (`roles/bigquery.user`)
27+
* [Gemini CLI](https://github.com/google-gemini/gemini-cli) installed with version **+v0.6.0**.
28+
* Setup Gemini CLI [Authentication](https://github.com/google-gemini/gemini-cli/tree/main?tab=readme-ov-file#-authentication-options).
29+
* A Google Cloud project with the **BigQuery API** enabled.
30+
* Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
31+
* IAM Permissions:
32+
* BigQuery User (`roles/bigquery.user`)
2433

2534
## Getting Started
2635

@@ -34,11 +43,11 @@ gemini extensions install https://github.com/gemini-cli-extensions/bigquery-data
3443

3544
### Configuration
3645

37-
Set the following environment variables before starting the Gemini CLI:
46+
Set the following environment variables before starting the Gemini CLI. These variables can be loaded from a `.env` file.
3847

39-
* `BIGQUERY_PROJECT`: The GCP project ID.
40-
* `BIGQUERY_LOCATION`: (Optional) The dataset location.
41-
* `BIGQUERY_USE_CLIENT_OAUTH`: (Optional) Set to `true` to use client-side OAuth for authorization.
48+
* `BIGQUERY_PROJECT`: The GCP project ID.
49+
* `BIGQUERY_LOCATION`: (Optional) The dataset location.
50+
* `BIGQUERY_USE_CLIENT_OAUTH`: (Optional) Set to `true` to use client-side OAuth for authorization.
4251

4352
Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
4453

0 commit comments

Comments
 (0)