Merge pull request #18 from DilumAluthge/dpa/readme-example-ssh-https

README: In the example, demonstrate how to use SSH for some repos and HTTPS for other repos

Author: pfitzseb

README.md

@@ -9,24 +9,23 @@ using MultiDocumenter
 clonedir = mktempdir()
 
 docs = [
-    ("JuliaDocs/Documenter.jl.git", "gh-pages") => MultiDocumenter.MultiDocRef(
+    ("JuliaDocs/Documenter.jl.git", "gh-pages", false) => MultiDocumenter.MultiDocRef(
         upstream = joinpath(clonedir, "Documenter"),
         path = "doc",
         name = "Documenter"
     ),
-    ("JuliaDebug/Infiltrator.jl.git", "gh-pages") => MultiDocumenter.MultiDocRef(
+    # using SSH for cloning is suggested when you're dealing with private repos, because
+    # an ssh-agent will handle your keys for you
+    # ("JuliaDebug/Infiltrator.jl.git", "gh-pages", true) => MultiDocumenter.MultiDocRef(
+    ("JuliaDebug/Infiltrator.jl.git", "gh-pages", false) => MultiDocumenter.MultiDocRef(
         upstream = joinpath(clonedir, "Infiltrator"),
         path = "inf",
         name = "Infiltrator"
     ),
 ]
 
-# using SSH for cloning is suggested when you're dealing with private repos, because
-# an ssh-agent will handle your keys for you
-# prefix = "[email protected]:"
-prefix = "https://github.com/"
-
-for ((remote, branch), docref) in docs
+for ((remote, branch, use_ssh), docref) in docs
+    prefix = use_ssh ? "[email protected]:" : "https://github.com/"
     run(`git clone --depth 1 $prefix$remote --branch $branch --single-branch $(docref.upstream)`)
 end