Skip to content
This repository was archived by the owner on Sep 11, 2020. It is now read-only.

Commit a6197bd

Browse files
committed
documentation changes
1 parent 2308066 commit a6197bd

File tree

23 files changed

+169
-82
lines changed

23 files changed

+169
-82
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# go-git [![GoDoc](https://godoc.org/srcd.works/go-git.v4?status.svg)](https://godoc.org/srcd.works/go-git.v4) [![Build Status](https://travis-ci.org/src-d/go-git.svg)](https://travis-ci.org/src-d/go-git) [![codecov.io](https://codecov.io/github/src-d/go-git/coverage.svg)](https://codecov.io/github/src-d/go-git) [![codebeat badge](https://codebeat.co/badges/b6cb2f73-9e54-483d-89f9-4b95a911f40c)](https://codebeat.co/projects/github-com-src-d-go-git)
22

3-
A low level and highly extensible git implementation in **pure Go**.
3+
A highly extensible git implementation in **pure Go**.
44

55
*go-git* aims to reach the completeness of [libgit2](https://libgit2.github.com/) or [jgit](http://www.eclipse.org/jgit/), nowadays covers the **majority** of the plumbing **read operations** and **some** of the main **write operations**, but lacks the main porcelain operations such as merges.
66

@@ -27,7 +27,7 @@ go get -u srcd.works/go-git.v4/...
2727
Examples
2828
--------
2929

30-
> Please note that the functions `CheckIfError` and `Info` used in the examples are from the [examples package](https://github.com/src-d/go-git/blob/master/examples/common.go#L17) just to be used in the examples.
30+
> Please note that the functions `CheckIfError` and `Info` used in the examples are from the [examples package](https://github.com/src-d/go-git/blob/master/_examples/common.go#L17) just to be used in the examples.
3131
3232

3333
### Basic example
@@ -109,7 +109,7 @@ Date: Fri Nov 11 13:23:22 2016 +0100
109109
...
110110
```
111111

112-
You can find this [example](examples/log/main.go) and many other at the [examples](examples) folder
112+
You can find this [example](_examples/log/main.go) and many other at the [examples](_examples) folder
113113

114114
Contribute
115115
----------
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

examples/log/main.go renamed to _examples/log/main.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ func main() {
1212
// Clones the given repository, creating the remote, the local branches
1313
// and fetching the objects, everything in memory:
1414
Info("git clone https://github.com/src-d/go-siva")
15-
r, err := git.Clone(memory.NewStorage(), nil, &git.CloneOptions{URL: "https://github.com/src-d/go-siva"})
15+
r, err := git.Clone(memory.NewStorage(), nil, &git.CloneOptions{
16+
URL: "https://github.com/src-d/go-siva",
17+
})
1618
CheckIfError(err)
1719

1820
// Gets the HEAD history from HEAD, just like does:
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)