From 86fa7617efcfb468837f58c9b530c4ef7cbcb460 Mon Sep 17 00:00:00 2001
From: Máximo Cuadros <mcuadros@gmail.com>
Date: Tue, 16 Feb 2016 17:21:00 +0100
Subject: package documentation

---
 doc.go | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

(limited to 'doc.go')

diff --git a/doc.go b/doc.go
index a37a12d..d6b3cf5 100644
--- a/doc.go
+++ b/doc.go
@@ -4,4 +4,31 @@
 //
 // We have been following the open/close principle in its design to facilitate
 // extensions.
+//
+// Small example extracting the commits from a repository:
+//  func ExampleBasic_printCommits() {
+//    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 {
+//    	panic(err)
+//    }
+//
+//    iter := r.Commits()
+//    defer iter.Close()
+//
+//    for {
+//    	commit, err := iter.Next()
+//    	if err != nil {
+//    		if err == io.EOF {
+//    			break
+//    		}
+//
+//    		panic(err)
+//    	}
+//
+//    	fmt.Println(commit)
+//  }
 package git
-- 
cgit