1 files changed, 35 insertions, 0 deletions
diff --git a/doc.go b/doc.go
new file mode 100644
index 0000000..b823943
--- /dev/null
+++ b/doc.go
@@ -0,0 +1,35 @@
+// Package git is a low level and highly extensible git client library for
+// reading repositories from git servers.  It is written in Go from scratch,
+// without any C dependencies.
+//
+// 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