Skip to content

Updated README with more descriptions of samples and key branches #159

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 26, 2025
Merged

Updated README with more descriptions of samples and key branches #159

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5a42494
Updated README with more descriptions of samples and key branches
cy245 Aug 21, 2025
496764b
README updates
cy245 Aug 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,21 @@ Android Identity Samples Repository

This repository contains a set of individual Android Studio projects to help you get
started writing/understanding Android identity features.

There are two main branches, `main` and `credman-compose`.

Branch `main` contains the primary samples for Credential Manager:
* `CredentialManager` - Simple app demonstrating how to use basic Credential Manager functions
* `CredentialProvider/MyVault` - Simple credential provider app implementation
* `SmsVerification` - Legacy sample using Play Service's SMS Verification APIs
* `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
Comment on lines +13 to +15
Copy link

Choose a reason for hiding this comment

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

medium

For better readability, consider using sub-bullets to describe the contents of the WebView directory, as the current single bullet point is quite dense.

Suggested change
* `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.


Branch `credman-compose` notably contain the `Shrine` mobile app with Wear OS support in two
modules:
* `Shrine` is a more developed mobile app featuring best practices and recommended UX when
using Credential Manager. The sample features multiple methods of sign-up, sign-in, settings
configuration, and session management.
* `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.
Comment on lines +22 to +23
Copy link

Choose a reason for hiding this comment

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

medium

The path Shrinewear/appkt seems to contain a typo. Did you mean Shrinewear/app? The appkt directory name is unusual.

Suggested change
* `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.