Skip to content

docs: clarify that Glanceboard requires a Gemini API key - #6

Open
raphdixon wants to merge 1 commit into
google-gemini:mainfrom
raphdixon:fix/readme-api-key-clarification
Open

docs: clarify that Glanceboard requires a Gemini API key#6
raphdixon wants to merge 1 commit into
google-gemini:mainfrom
raphdixon:fix/readme-api-key-clarification

Conversation

@raphdixon

Copy link
Copy Markdown

The README previously stated "fully local" and "no cloud account needed," which is misleading since a Gemini API key is required for image generation and intelligence features.

Changes

  • Updated "no cloud account needed" → clarifies the server runs locally or can be deployed to the cloud, but requires a Gemini API key
  • Updated "Fully local" → "Self-hosted" with a note that a Gemini API key is required
  • Both references now link to the existing API key setup section

@raphdixon
raphdixon requested a review from osanseviero as a code owner July 31, 2026 09:10
@google-cla

google-cla Bot commented Jul 31, 2026

Copy link
Copy Markdown

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the README.md to reflect that the application requires a Gemini API key and can be self-hosted locally or deployed to the cloud. The review feedback points out a grammatical inconsistency in the self-hosted description and suggests a correction to maintain parallelism.

Comment thread README.md
- **Custom prompts** — Edit the image generation prompt template
- **Email digest** — Optional Gmail integration shows unread email summaries ([setup required](EMAIL_SETUP.md))
- **Fully local** — Runs on your own machine, no cloud account required
- **Self-hosted** — Runs on your own machine or deploy to the cloud; requires a [Gemini API key](#api-key-setup)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The phrase "Runs on your own machine or deploy to the cloud" is grammatically inconsistent because it mixes the third-person verb "Runs" with the base verb "deploy". Updating it to "can be deployed" ensures grammatical parallelism and consistency with the rest of the document.

Suggested change
- **Self-hosted** — Runs on your own machine or deploy to the cloud; requires a [Gemini API key](#api-key-setup)
- **Self-hosted** — Runs on your own machine or can be deployed to the cloud; requires a [Gemini API key](#api-key-setup)

The README previously stated 'fully local' and 'no cloud account needed,' which is misleading since a Gemini API key is required for image generation and intelligence features. Updated to clarify the server runs locally (or can be deployed to the cloud) but always requires an API key.
@raphdixon
raphdixon force-pushed the fix/readme-api-key-clarification branch from 4264396 to 57c1da9 Compare July 31, 2026 09:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant