blob: b823943f2d68c732a60bc31da0355d3d0e07def2 [file] [log] [blame]
// 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