Skip to content

Commit 30b8617

Browse files
committed
Document the only case where git is required
This is now just when using git's built-in credential cache, for obvious reasons.
1 parent b01af4f commit 30b8617

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

readme.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ and may issue IDE-only warnings if no active sponsorship is detected.*
1414
<!-- https://github.com/devlooped/.github/raw/main/sponsorlink.md -->
1515

1616
Packages the official [Git Credential Manager](https://github.com/git-ecosystem/git-credential-manager/) cross-platform credential store
17-
implementation supporting Windows, macOS and Linux for use as a NS2.0 library with no UI or external dependencies beyond just git.
17+
implementation supporting Windows, macOS and Linux for use as a NS2.0 library with no UI or external dependencies.
1818

1919
Release version numbers track the [GCM releases](https://github.com/GitCredentialManager/git-credential-manager/releases) themselves.
2020

@@ -47,6 +47,11 @@ The library targets .NET Standard 2.0 for broad applicability.
4747
Supported [credential stores](https://github.com/git-ecosystem/git-credential-manager/blob/main/docs/credstores.md) and their
4848
configuration is shared with the GCM project itself.
4949

50+
51+
> [!IMPORTANT]
52+
> If you use Git's built-in credential cache, a working installation of git
53+
> is required. See [GCM docs](https://github.com/git-ecosystem/git-credential-manager/blob/main/docs/credstores.md#gits-built-in-credential-cache).
54+
5055
<!-- #content -->
5156

5257
## Releasing

0 commit comments

Comments
 (0)