docs

getantibody · Aug 16, 2016 · 630fcbd · 630fcbd
1 parent 5ea4c59
commit 630fcbd
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/project/git.go b/project/git.go
@@ -13,7 +13,9 @@ type gitProject struct {
 	folder  string
 }
 
-func NewGit(targetFolder, repo, version string) Project {
+// NewGit A git project can be any repository in any given branch. It will
+// be downloaded to the provided cwd
+func NewGit(cwd, repo, version string) Project {
 	var url string
 	switch {
 	case strings.HasPrefix(repo, "http://"):
@@ -29,7 +31,7 @@ func NewGit(targetFolder, repo, version string) Project {
 	default:
 		url = "https://github.com/" + repo
 	}
-	folder := targetFolder + strings.Replace(
+	folder := cwd + strings.Replace(
 		strings.Replace(
 			url, ":", "-COLON-", -1,
 		), "/", "-SLASH-", -1,

diff --git a/project/local.go b/project/local.go
@@ -1,5 +1,6 @@
 package project
 
+// NewLocal Returns a local project, which can be any folder you want to
 func NewLocal(folder string) Project {
 	return localProject{folder}
 }