Merge pull request #73 from MESHMD/improve-git-doc
authorAaron Stone <aaron@serendipity.cx>
Sat, 13 Jul 2013 22:06:06 +0000 (15:06 -0700)
committerAaron Stone <aaron@serendipity.cx>
Sat, 13 Jul 2013 22:06:06 +0000 (15:06 -0700)
Improve Git SSH usage documentation

README.GIT.markdown

index d6b8afe..846bdcc 100644 (file)
@@ -76,9 +76,15 @@ Keep the repository at the latest revision (note: this will always overwrite loc
 For sources that use SSH (eg, `username@server:...`)
 ----------------------------------------------------
 
-Manage your SSH keys with Puppet and use `require` in your `vcsrepo`
-to ensure they are present.  For more information, see the `require`
-metaparameter documentation[1].
+If your SSH key is associated with a user, simply fill the `user` parameter to use his keys.
+
+Example:
+
+    user => 'toto'  # will use toto's $HOME/.ssh setup
+
+
+Otherwise, manage your SSH keys with Puppet and use `require` in your `vcsrepo` to ensure they are present.
+For more information, see the `require` metaparameter documentation[1].
 
 More Examples
 -------------