Skip to content

Commit 0f79816

Browse files
authored
Merge pull request #185 from android/update-readme-RC
Update README to include RC
2 parents b142a70 + a1e39b9 commit 0f79816

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

Shrine/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,16 @@ server response from requesting passkey registration options. This is then used
104104
in `AuthApiService.kt`, and the server's returned JSON is expected to have those fields. You can
105105
verify this by looking at the logs in Logcat after making any server request.
106106

107+
### Restore Credentials
108+
109+
Restore Credentials are passkeys that are used to restore a user's app accounts when setting up a
110+
new device. In Shrine, this is created in `AuthenticationScreen.kt` upon signing in successfully and
111+
passing the `createRestoreKey()` function in to the View Model. This is also done in
112+
`RegisterPasswordScreen.kt`. When launching the app for the first time, Shrine checks for an
113+
existing restore key by calling `viewModel.checkForStoredRestoreKey()` in `AuthenticationScreen.kt`.
114+
If one exists, it uses that to log the user in automatically. You can read more about how Restore
115+
Credentials work at https://developer.android.com/identity/sign-in/restore-credentials.
116+
107117
## Wear OS Module
108118
This sample also includes a Wear OS module that implements Credential Manager for a Wear OS app.
109119
See the wear/README.md file to learn about Wear OS behaviors and limitations.

0 commit comments

Comments
 (0)