[Fix #117] Add documentation for ssh-agent

modules/ssh-agent/README.md

@@ -0,0 +1,36 @@
+SSH-Agent
+=========
+
+Provides for an easier use of [ssh-agent][1].
+
+Settings
+--------
+
+### Agent Forwarding
+
+To enable ssh-agent forwarding, add the following line to *zshrc*:
+
+    zstyle ':omz:module:ssh-agent' forwarding 'yes'
+
+### Identities
+
+To load multiple identities, add the following line to *zshrc*:
+
+    zstyle ':omz:module:ssh-agent' identities 'id_rsa' 'id_rsa2' 'id_github'
+
+Authors
+-------
+
+*The authors of this module should be contacted via the [issue tracker][2].*
+
+  - [Robby Russell](https://github.com/robbyrussell)
+  - [Theodore Robert Campbell Jr](https://github.com/trcjr)
+  - [Joseph M. Reagle Jr.](https://github.com/reagle)
+  - [Florent Thoumie](https://github.com/flz)
+  - [Jonas Pfenniger](https://github.com/zimbatm)
+  - [Gareth Owen](https://github.com/gwjo)
+  - [Sorin Ionescu](https://github.com/sorin-ionescu)
+
+[1]: http://www.openbsd.org/cgi-bin/man.cgi?query=ssh-agent&sektion=1
+[2]: https://github.com/sorin-ionescu/oh-my-zsh/issues
+

modules/ssh-agent/init.zsh

@@ -10,15 +10,6 @@
 #   gwjo <gowen72@gmail.com>
 #   Sorin Ionescu <sorin.ionescu@gmail.com>
 #
-# Usage:
-#   To enable agent forwarding, add the following to your .zshrc:
-#
-#     zstyle ':omz:module:ssh-agent' forwarding 'yes'
-#
-#   To load multiple identities, add the following to your .zshrc:
-#
-#     zstyle ':omz:module:ssh-agent' identities 'id_rsa' 'id_rsa2' 'id_github'
-#
 
 if (( ! $+commands[ssh-agent] )); then
   return 1