docs: clarify that Glanceboard requires a Gemini API key - #6
Conversation
|
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. |
There was a problem hiding this comment.
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.
| - **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) |
There was a problem hiding this comment.
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.
| - **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.
4264396 to
57c1da9
Compare
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