docs: add short project overview#2
Draft
SkyBeamProject wants to merge 1 commit intomainfrom
Draft
Conversation
There was a problem hiding this comment.
Code Review
This pull request introduces an OVERVIEW.md file providing a high-level description of the Python client for the Google Bard API, including authentication details and available interfaces. The review feedback suggests updating the terminology to reflect Google's rebranding of Bard to Gemini and improving the file's readability by breaking down long paragraphs into multiple lines.
| @@ -0,0 +1,3 @@ | |||
| # Overview | |||
|
|
|||
| A reverse-engineered Python client for Google Bard's chatbot API. Authentication is done by supplying the `__Secure-1PSID` and `__Secure-1PSIDTS` cookies from an active bard.google.com session. It exposes synchronous (`Chatbot`) and asynchronous (`AsyncChatbot`) APIs, plus a CLI and a "quick mode" driven by environment variables for shell shortcuts. | |||
There was a problem hiding this comment.
The project overview is accurate but could be improved for readability and current branding. Google has rebranded Bard to Gemini, so mentioning this would be helpful for users. Also, the line is very long; breaking it into multiple lines improves readability in text editors.
Suggested change
| A reverse-engineered Python client for Google Bard's chatbot API. Authentication is done by supplying the `__Secure-1PSID` and `__Secure-1PSIDTS` cookies from an active bard.google.com session. It exposes synchronous (`Chatbot`) and asynchronous (`AsyncChatbot`) APIs, plus a CLI and a "quick mode" driven by environment variables for shell shortcuts. | |
| A reverse-engineered Python client for Google Bard's (now Gemini) chatbot API. | |
| Authentication is done by supplying the __Secure-1PSID and __Secure-1PSIDTS cookies from an active bard.google.com session. | |
| It exposes synchronous (Chatbot) and asynchronous (AsyncChatbot) APIs, plus a CLI and a "quick mode" driven by environment variables for shell shortcuts. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds an
OVERVIEW.mdwith a concise project summary.Generated by Claude Code