diff --git a/plugins/gpg-agent/README.md b/plugins/gpg-agent/README.md index 8eeb94f92..d66c37a5b 100644 --- a/plugins/gpg-agent/README.md +++ b/plugins/gpg-agent/README.md @@ -1,6 +1,11 @@ # gpg-agent -Enables [GPG's gpg-agent](https://www.gnupg.org/documentation/manuals/gnupg/) if it is not running. +Applies some fixes for some common issues encountered with [GPG's gpg-agent](https://www.gnupg.org/documentation/manuals/gnupg/). + +More specifically, this plugin: + +- Updates the `GPG_TTY` environment variable before each shell execution. +- Updates the `SSH_AUTH_SOCK` environment variable if `enable-ssh-support` is turned on. To use it, add `gpg-agent` to the plugins array of your zshrc file: