Refresh README for 2.0.0 surface#62
Merged
Merged
Conversation
Updates the docs to match the post-#61 reality: - Documents ISearchableCredentialStore and shows the runtime cast pattern consumers need on macOS/Linux when they want enumeration. - Adds a Linux runtime prerequisites section (libsecret + Secret Service, with a pointer to the dbus-run-session + gnome-keyring-daemon workflow used in CI). - Walks through adding a custom Credential subclass: [JsonDerivedType] on the base, optional ICredentialFactory<T> registration, and the note that SemanticString<T> properties round-trip via the RoundTrip converter automatically. - Adds a "don't dispose the singleton" warning -- calling Dispose() on CredentialCache.Instance breaks it process-wide. - Adds the Store property and ISearchableCredentialStore rows to the API summary table; native API column in the platform table is now accurate. https://claude.ai/code/session_017B9mN9F7C3pWGZRyoKBd6R
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
2 participants
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.
Bring the README up to date with the
2.0.0surface.What changed
ISearchableCredentialStoreis documented. Shows the runtime-cast pattern so consumers on macOS/Linux know they have to either track persona GUIDs themselves or fall through.libsecret-1-0plus a Secret Service implementation, with a pointer to thedbus-run-session+gnome-keyring-daemonsetup used bycross-platform.ymlfor CI / headless cases.[JsonDerivedType]on theCredentialbase, optionalICredentialFactory<T>registration, and the note thatSemanticString<T>properties round-trip throughktsu.RoundTripStringJsonConverterautomatically.using var c = CredentialCache.Instance;puts the process-wide singleton in a disposed state.Storeproperty and anISearchableCredentialStorerow; the platform table's native-API column is accurate (CredReadW/SecKeychainAddGenericPassword/secret_password_store_sync).Test plan
https://claude.ai/code/session_017B9mN9F7C3pWGZRyoKBd6R
Generated by Claude Code