Updated README with more descriptions of samples and key branches #159
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @cy245, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request updates the README.md file to enhance clarity and provide more comprehensive information about the repository's structure and content. The changes introduce detailed descriptions of the two primary branches, main and credman-compose, and elaborate on the specific Android identity samples available within each. This update aims to improve the onboarding experience for new users by clearly outlining the purpose and functionality of the various sample applications.
Highlights
- README Update: Added detailed descriptions for the
mainandcredman-composebranches, clarifying their purpose and the types of samples they contain. - Sample Descriptions: Provided specific information about samples like
CredentialManager,CredentialProvider/MyVault,SmsVerification, andWebView(includingCredentialManagerWebViewandWebkitWebView) under themainbranch. - Shrine Samples: Included descriptions for the
ShrineandShrinewear/appktsamples found in thecredman-composebranch, highlighting their features such as best practices, recommended UX, and seamless authentication.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request updates the main README.md to provide more details about the repository's structure, specifically describing the key branches and the sample projects they contain. The changes are helpful for new users navigating the repository. I've added a couple of suggestions to improve readability and fix a potential typo in a directory path.
| * `WebView` - Contains 2 folders. `CredentialManagerWebView` contains code snippets to use | ||
| Credential Manager with WebView. `WebkitWebView` contains a sample app that uses the Webkit | ||
| library to implement passkey creation in WebView |
There was a problem hiding this comment.
For better readability, consider using sub-bullets to describe the contents of the WebView directory, as the current single bullet point is quite dense.
| * `WebView` - Contains 2 folders. `CredentialManagerWebView` contains code snippets to use | |
| Credential Manager with WebView. `WebkitWebView` contains a sample app that uses the Webkit | |
| library to implement passkey creation in WebView | |
| * `WebView` - Contains samples for using Credential Manager with WebView: | |
| * `CredentialManagerWebView` - Contains code snippets to use Credential Manager with WebView. | |
| * `WebkitWebView` - Contains a sample app that uses the Webkit library to implement passkey creation in WebView. |
| * `Shrinewear/appkt` is a Wear app that works together with the Shrine mobile app. It features | ||
| seamless authentication via passkey and Sign-in-with-Google logins. |
There was a problem hiding this comment.
The path Shrinewear/appkt seems to contain a typo. Did you mean Shrinewear/app? The appkt directory name is unusual.
| * `Shrinewear/appkt` is a Wear app that works together with the Shrine mobile app. It features | |
| seamless authentication via passkey and Sign-in-with-Google logins. | |
| * `Shrinewear/app` is a Wear app that works together with the Shrine mobile app. It features | |
| seamless authentication via passkey and Sign-in-with-Google logins. |
There was a problem hiding this comment.
LGTM with a comment to update Shrine block given pending #152.
Thanks Chiping!
README.md
Outdated
| Credential Manager with WebView. `WebkitWebView` contains a sample app that uses the Webkit | ||
| library to implement passkey creation in WebView | ||
|
|
||
| Branch `credman-compose` notably contains 2 `Shrine` samples: |
There was a problem hiding this comment.
Updated, and ack on this
No description provided.