Diff
1diff --git a/plugins/ssh-agent/README.md b/plugins/ssh-agent/README.md
2new file mode 100644
3index 0000000000000000000000000000000000000000..00af42f01a2da775e02adba1a4db209cb3c52605
4--- /dev/null
5+++ b/plugins/ssh-agent/README.md
6@@ -0,0 +1,38 @@
7+# ssh-agent plugin
8+
9+This plugin starts automatically `ssh-agent` to set up and load whichever
10+credentials you want for ssh connections.
11+
12+To enable it, add `ssh-agent` to your plugins:
13+
14+```zsh
15+plugins=(... ssh-agent)
16+```
17+
18+## Instructions
19+
20+To enable **agent forwarding support** add the following to your zshrc file:
21+
22+```zsh
23+zstyle :omz:plugins:ssh-agent agent-forwarding on
24+```
25+
26+To **load multiple identities** use the `identities` style, For example:
27+
28+```zsh
29+zstyle :omz:plugins:ssh-agent identities id_rsa id_rsa2 id_github
30+```
31+
32+To **set the maximum lifetime of the identities**, use the `lifetime` style.
33+The lifetime may be specified in seconds or as described in sshd_config(5)
34+(see _TIME FORMATS_). If left unspecified, the default lifetime is forever.
35+
36+```zsh
37+zstyle :omz:plugins:ssh-agent lifetime 4h
38+```
39+
40+## Credits
41+
42+Based on code from Joseph M. Reagle: http://www.cygwin.com/ml/cygwin/2001-06/msg00537.html
43+
44+Agent-forwarding support based on ideas from Florent Thoumie and Jonas Pfenniger
45diff --git a/plugins/ssh-agent/ssh-agent.plugin.zsh b/plugins/ssh-agent/ssh-agent.plugin.zsh
46index 6fdeb2725afef377027ce0def1f7317e74f31d12..81f27ca008d874ea969592aad9340a2824d38c36 100644
47--- a/plugins/ssh-agent/ssh-agent.plugin.zsh
48+++ b/plugins/ssh-agent/ssh-agent.plugin.zsh
49@@ -1,32 +1,3 @@
50-#
51-# INSTRUCTIONS
52-#
53-# To enable agent forwarding support add the following to
54-# your .zshrc file:
55-#
56-# zstyle :omz:plugins:ssh-agent agent-forwarding on
57-#
58-# To load multiple identities use the identities style, For
59-# example:
60-#
61-# zstyle :omz:plugins:ssh-agent identities id_rsa id_rsa2 id_github
62-#
63-# To set the maximum lifetime of the identities, use the
64-# lifetime style. The lifetime may be specified in seconds
65-# or as described in sshd_config(5) (see TIME FORMATS)
66-# If left unspecified, the default lifetime is forever.
67-#
68-# zstyle :omz:plugins:ssh-agent lifetime 4h
69-#
70-# CREDITS
71-#
72-# Based on code from Joseph M. Reagle
73-# http://www.cygwin.com/ml/cygwin/2001-06/msg00537.html
74-#
75-# Agent forwarding support based on ideas from
76-# Florent Thoumie and Jonas Pfenniger
77-#
78-
79 local _plugin__ssh_env
80 local _plugin__forwarding
81
82@@ -76,4 +47,3 @@ fi
83 unfunction _plugin__start_agent
84 unset _plugin__forwarding
85 unset _plugin__ssh_env
86-