documentation

Author: mcuadros

README.md

@@ -37,22 +37,23 @@ go get -u gopkg.in/src-d/go-git.v3/...
 Examples
 --------
 
-Basic example: retrieving the commits for a given repository:
+Retrieving the commits for a given repository:
 
 ```go
 r, err := git.NewRepository("https://github.com/src-d/go-git", nil)
 if err != nil {
 	panic(err)
 }
 
-if err := r.Pull("origin", "refs/heads/master"); err != nil {
+if err := r.PullDefault(); err != nil {
 	panic(err)
 }
 
 iter := r.Commits()
 defer iter.Close()
 
 for {
+	//the commits are not shorted in any special order
 	commit, err := iter.Next()
 	if err != nil {
 		if err == io.EOF {
@@ -86,6 +87,32 @@ Date:   2015-12-11 17:57:10 +0100 +0100
 ...
 ```
 
+Retrieving the latest commit for a given repository:
+
+```go
+r, err := git.NewRepository("https://github.com/src-d/go-git", nil)
+if err != nil {
+	panic(err)
+}
+
+if err := r.PullDefault(); err != nil {
+	panic(err)
+}
+
+hash, err := r.Remotes[git.DefaultRemoteName].Head()
+if err != nil {
+	panic(err)
+}
+
+commit, err := r.Commit(hash)
+if err != nil {
+	panic(err)
+}
+
+fmt.Println(commit)
+```
+
+
 Acknowledgements
 ----------------
 

doc.go

@@ -32,4 +32,4 @@
 //    	fmt.Println(commit)
 //    }
 //  }
-package git
+package git // import "gopkg.in/src-d/go-git.v3"

examples/basic/main.go

@@ -9,24 +9,21 @@ import (
 )
 
 func main() {
-	fmt.Printf("Retrieving %q ...\n", os.Args[2])
-	r, err := git.NewRepository(os.Args[2], nil)
+	fmt.Printf("Retrieving %q ...\n", os.Args[1])
+	r, err := git.NewRepository(os.Args[1], nil)
 	if err != nil {
 		panic(err)
 	}
 
-	if err := r.Pull("origin", "refs/heads/master"); err != nil {
+	if err := r.PullDefault(); err != nil {
 		panic(err)
 	}
 
-	dumpCommits(r)
-}
-
-func dumpCommits(r *git.Repository) {
 	iter := r.Commits()
 	defer iter.Close()
 
 	for {
+		//the commits are not shorted in any special order
 		commit, err := iter.Next()
 		if err != nil {
 			if err == io.EOF {

examples/latest/latest.go

@@ -0,0 +1,32 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"gopkg.in/src-d/go-git.v3"
+)
+
+func main() {
+	fmt.Printf("Retrieving latest commit from: %q ...\n", os.Args[1])
+	r, err := git.NewRepository(os.Args[1], nil)
+	if err != nil {
+		panic(err)
+	}
+
+	if err := r.Pull(git.DefaultRemoteName, "refs/heads/master"); err != nil {
+		panic(err)
+	}
+
+	hash, err := r.Remotes[git.DefaultRemoteName].Head()
+	if err != nil {
+		panic(err)
+	}
+
+	commit, err := r.Commit(hash)
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(commit)
+}