aboutsummaryrefslogtreecommitdiffstats
path: root/doc.go
blob: 03367b8f5a3096245f034352c19780862876d905 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
// 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 := git.NewMemoryRepository()
//         o := &git.CloneOptions{
//             URL: "https://github.com/src-d/go-git",
//         }
//         if err := r.Clone(o); err != nil {
//             panic(err)
//         }
//
//         iter, err := r.Commits()
//         if err != nil {
//             panic(err)
//         }
//         defer iter.Close()
//
//         for {
//             commit, err := iter.Next()
//             if err != nil {
//                 if err == io.EOF {
//                     break
//                 }
//                 panic(err)
//             }
//
//             fmt.Println(commit)
//         }
//    }
package git // import "gopkg.in/src-d/go-git.v4"